GET api/v1/UserAdminAPI/GetAllUsers?accountID={accountID}
Returns all user based on accountID. iff accountID not supplied, it will use the one from current user.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accountID | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.Users.UserName | Description | Type | Additional information |
---|---|---|---|
Error | TwoSms.CustomerPortalRole.API.Misc.Error |
None. |
|
ResponseData | TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.Users.User |
None. |
Response Formats
application/json, text/json
Sample:
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": [ { "ID": "7732dab3-8784-457b-b31f-3086067bc5e7", "AgreementDate": "2025-04-02T07:27:51.8112908+00:00", "AccountID": "79785464-54a7-40d7-89bf-a822cf7bd01a", "AdminUser": true, "DateCreated": "2025-04-02T07:27:51.8112908+00:00", "DateModified": "2025-04-02T07:27:51.8112908+00:00", "DeclineDate": "2025-04-02T07:27:51.8112908+00:00", "DisplayName": "sample string 6", "DPAVersion": "sample string 7", "EmailAddress": "sample string 8", "Enabled": true, "LanguageID": "bf2ac564-15ca-47ea-b63c-c5c9b602ee0a", "MobilePhone": "sample string 12", "Password": "sample string 13", "Pin": "sample string 14", "Preferences": 0, "PrivacyPolicyVersion": "sample string 15", "TimeZone": "sample string 16", "Username": "sample string 17" }, { "ID": "7732dab3-8784-457b-b31f-3086067bc5e7", "AgreementDate": "2025-04-02T07:27:51.8112908+00:00", "AccountID": "79785464-54a7-40d7-89bf-a822cf7bd01a", "AdminUser": true, "DateCreated": "2025-04-02T07:27:51.8112908+00:00", "DateModified": "2025-04-02T07:27:51.8112908+00:00", "DeclineDate": "2025-04-02T07:27:51.8112908+00:00", "DisplayName": "sample string 6", "DPAVersion": "sample string 7", "EmailAddress": "sample string 8", "Enabled": true, "LanguageID": "bf2ac564-15ca-47ea-b63c-c5c9b602ee0a", "MobilePhone": "sample string 12", "Password": "sample string 13", "Pin": "sample string 14", "Preferences": 0, "PrivacyPolicyVersion": "sample string 15", "TimeZone": "sample string 16", "Username": "sample string 17" } ] } }
application/xml, text/xml
Sample:
<ResponseOfListOfUser xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error> <ErrorCode>sample string 1</ErrorCode> <ErrorReason>sample string 2</ErrorReason> </Error> <ResponseData> <Result>sample string 1</Result> <Identification> <UserId>sample string 1</UserId> </Identification> <Detail> <User> <ID>7732dab3-8784-457b-b31f-3086067bc5e7</ID> <AgreementDate>2025-04-02T07:27:51.8112908+00:00</AgreementDate> <AccountID>79785464-54a7-40d7-89bf-a822cf7bd01a</AccountID> <AdminUser>true</AdminUser> <DateCreated>2025-04-02T07:27:51.8112908+00:00</DateCreated> <DateModified>2025-04-02T07:27:51.8112908+00:00</DateModified> <DeclineDate>2025-04-02T07:27:51.8112908+00:00</DeclineDate> <DisplayName>sample string 6</DisplayName> <DPAVersion>sample string 7</DPAVersion> <EmailAddress>sample string 8</EmailAddress> <Enabled>true</Enabled> <LanguageID>bf2ac564-15ca-47ea-b63c-c5c9b602ee0a</LanguageID> <Language>sample string 11</Language> <MobilePhone>sample string 12</MobilePhone> <Password>sample string 13</Password> <Pin>sample string 14</Pin> <Preferences>NONE</Preferences> <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion> <TimeZone>sample string 16</TimeZone> <Username>sample string 17</Username> </User> <User> <ID>7732dab3-8784-457b-b31f-3086067bc5e7</ID> <AgreementDate>2025-04-02T07:27:51.8112908+00:00</AgreementDate> <AccountID>79785464-54a7-40d7-89bf-a822cf7bd01a</AccountID> <AdminUser>true</AdminUser> <DateCreated>2025-04-02T07:27:51.8112908+00:00</DateCreated> <DateModified>2025-04-02T07:27:51.8112908+00:00</DateModified> <DeclineDate>2025-04-02T07:27:51.8112908+00:00</DeclineDate> <DisplayName>sample string 6</DisplayName> <DPAVersion>sample string 7</DPAVersion> <EmailAddress>sample string 8</EmailAddress> <Enabled>true</Enabled> <LanguageID>bf2ac564-15ca-47ea-b63c-c5c9b602ee0a</LanguageID> <Language>sample string 11</Language> <MobilePhone>sample string 12</MobilePhone> <Password>sample string 13</Password> <Pin>sample string 14</Pin> <Preferences>NONE</Preferences> <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion> <TimeZone>sample string 16</TimeZone> <Username>sample string 17</Username> </User> </Detail> </ResponseData> </ResponseOfListOfUser>