Evo Voice

<back to all web services

ListUsers

Gets the users for the specified account

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager
The following routes are available for this service:
GET/users
ListUsers Parameters:
NameParameterData TypeRequiredDescription
AccountIdsqueryList<string>NoThe account IDs whose users you want to retrieve
EmailFilterquerystringNoFilter by email
ListRequest<T> Parameters:
NameParameterData TypeRequiredDescription
PageformintNoThe page of data to retrieve
AllformboolNoIf you want all objects to be returned. This should be used with care
CountPerPageformintNoThe number per page to retrieve
SpecificIdsformList<string>NoSpecific IDs
SortFieldformstringNoSpecify a sort field
SortOrderformSortOrdersNoSpecify a sort order
SimplifiedPagingformboolNoDisables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
SortOrders Enum:
Ascend
Descend
UserInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
IsAuthenticatedformboolNo
FirstNameformstringNo
LastNameformstringNo
NameformstringNo
AvatarUrlformstringNo
EmailAddressformstringNo
RolesformList<string>No
AccountIdsformList<string>No
AccountNamesformList<string>No
DashboardPermissionsformList<DashboardPermissions>No
DashboardPermissions Enum:
ViewFiles
ViewNotifications
ViewSessions
ViewEndpoints
ViewReports
ViewCustomers
ViewFlows
ListResponse<AccountInfo> Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<AccountInfo>NoThe items
TotalCountformintNoThe total number of items
TotalPagesformintNoThe total number of pages
HasMorePagesformboolNoAre there more pages of items? Used with simplified paging
AccountInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe name of this account
ParentAccountIdformstringNoThe ID of this account's parent
TwilioAccountSidformstringNoThe twilio account SID
AncestorIdsformList<string>NoThe ancestors of this account. Useful for breadcrumbs
MaxPhoneNumbersformintNoThe max number of phone numbers this account can have
IsBYOAformboolNoThis account is BYOA
TrustHubProfileSidformstringNoTrustHub Profile Sid
LogoIdformstringNoThe ID of the logo file
LogoUriformstringNoThe URI of the logo file
BillingSettingsformBillingSettingsNoThe billing settings for this account
EntityInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of the object
DateCreatedformstringNoThe date the object was created
DateLastModifiedformstringNoThe date the object was last modified
CreatedByformstringNoThe user that created this object
LastModifiedByformstringNoThe user that last modified this object
BillingSettings Parameters:
NameParameterData TypeRequiredDescription
BaseformBillingItemNo
LocalNumbersformBillingItemNo
TollFreeNumbersformBillingItemNo
InboundVoiceCallsformBillingItemNo
OutboundVoiceCallsformBillingItemNo
InboundFaxesformBillingItemNo
OutboundFaxesformBillingItemNo
InboundSmsMessagesformBillingItemNo
OutboundSmsMessagesformBillingItemNo
BillingItem Parameters:
NameParameterData TypeRequiredDescription
BaseCostformdoubleNo
RawUnitMultiplierformdoubleNo
UnitCostformdoubleNo
AllowanceformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListResponseOfUserInfoARNYmvUm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
  <HasMorePages>false</HasMorePages>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
    <d2p1:UserInfo>
      <d2p1:AccountIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:AccountIds>
      <d2p1:AccountNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:AccountNames>
      <d2p1:AvatarUrl>String</d2p1:AvatarUrl>
      <d2p1:DashboardPermissions>
        <d2p1:DashboardPermissions>ViewFiles</d2p1:DashboardPermissions>
      </d2p1:DashboardPermissions>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:IsAuthenticated>false</d2p1:IsAuthenticated>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Roles>
    </d2p1:UserInfo>
  </Items>
  <TotalCount>0</TotalCount>
  <TotalPages>0</TotalPages>
</ListResponseOfUserInfoARNYmvUm>