Evo Voice

<back to all web services

ListCustomers

Retrieve customers

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/customers
ListCustomers Parameters:
NameParameterData TypeRequiredDescription
AccountIdsqueryList<string>NoFilter by accounts
NameFilterquerystringNoFilter by name
ParentCustomerIdsqueryList<string>NoThe IDs of the parent customers you want to filter by
ShallowParentqueryboolNoIf you want a shall parent customer filter (e.g. no deep children)
TagIdsqueryList<string>NoThe list of tag IDs to filter by (must contain all)
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
CustomerInfo Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNoThe ID of the account associated with this customer
ParentCustomerIdformstringNoThe parent customer ID for this customer
BreadcrumbformList<CustomerBreadcrumb>NoThe breadcrumb to this customer
AccountNameformstringNoThe name of the account associated with this customer
IsStagingformboolNoIs this customer staging or production?
NameformstringNoThe name of the company
ReferenceIdformstringNoThe reference ID for this company
DataformStructNoThis customer's data values
TagsformList<Tag>NoThe list of tags for this customer
ScheduleformScheduleNoThis customer's schedule
IntegrationDataformEntityIntegrationDataNoIntegration data for this customer
OverrideBillingSettingsformboolNoOverride this customer's billing settings? Otherwise inherits from parent
BillingSettingsformBillingSettingsNoBilling settings for this customer
OverrideAppSettingsformboolNoShould this customer override the parent customer's app settings
AppSettingsformAppSettingsNoApp / Portal settings for this customer
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
CustomerBreadcrumb Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
Value Parameters:
NameParameterData TypeRequiredDescription
BoolValueformbool?No
StringValueformstringNo
NumberValueformdouble?No
ListValueformList<Struct>No
StructValueformStructNo
Tag Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
ColorformTagColorsNo
TagColors Enum:
Magenta
Red
Volcano
Orange
Gold
Lime
Green
Cyan
Blue
GeekBlue
Purple
Schedule Parameters:
NameParameterData TypeRequiredDescription
TimeZoneIdformstringNo
InheritformboolNo
ForceClosedformboolNo
RulesformList<SchedulingRule>No
DefaultStateformstringNo
SchedulingRule Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
PriorityformintNo
StateformstringNo
SourceformstringNo
ConditionformstringNo
SimpleRuleTypeformSimpleSchedulingRuleTypesNo
CustomerStateformstringNo
FlowIdformstringNo
FlowParamsformStructNo
IsAllDayformboolNo
StartDateformstringNo
StartTimeformstringNo
EndTimeformstringNo
BySetPositionformList<int>No
ByMonthformList<int>No
ByWeekNoformList<int>No
ByYearDayformList<int>No
ByMonthDayformList<int>No
ByDayformList<ScheduleDay>No
ByHourformList<int>No
ByMinuteformList<int>No
IntervalformintNo
CountformintNo
UntilDateformstringNo
FrequencyformSchedulingRuleFrequencyNo
SimpleSchedulingRuleTypes Enum:
Always
CustomerState
Time
ScheduleDay Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
DayOfWeekformDayOfWeekNo
SchedulingRuleFrequency Enum:
None
Secondly
Minutely
Hourly
Daily
Weekly
Monthly
Yearly
IntegrationData Parameters:
NameParameterData TypeRequiredDescription
ThirdPartyIdformstringNo
BillingSettings Parameters:
NameParameterData TypeRequiredDescription
BaseformBillingItemNo
LocalNumbersformBillingItemNo
TollFreeNumbersformBillingItemNo
InboundVoiceCallsformBillingItemNo
OutboundVoiceCallsformBillingItemNo
InboundFaxesformBillingItemNo
OutboundFaxesformBillingItemNo
InboundSmsMessagesformBillingItemNo
OutboundSmsMessagesformBillingItemNo
BillingItem Parameters:
NameParameterData TypeRequiredDescription
BaseCostformdoubleNo
RawUnitMultiplierformdoubleNo
UnitCostformdoubleNo
AllowanceformintNo
AppSettings Parameters:
NameParameterData TypeRequiredDescription
EnablePhoneNumberManagementformboolNo
EnableDeviceManagementformboolNo
EnableDialerformboolNo
EnableCallHistoryformboolNo
ShowFileNameInMessageCenterformboolNo
ChakraThemeformstringNo
CustomCssformstringNo
PageTitleformstringNo
StringMappingsformstringNo
LogoutUrlformstringNo
PortMyNumberUrlformstringNo
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

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /customers HTTP/1.1 
Host: evovoice.io 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":[{"accountId":"String","parentCustomerId":"String","breadcrumb":[{"id":"String","name":"String"}],"accountName":"String","isStaging":false,"name":"String","referenceId":"String","data":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"tags":[{"id":"String","name":"String","color":"Magenta"}],"schedule":{"timeZoneId":"String","inherit":false,"forceClosed":false,"rules":[{"id":"String","name":"String","priority":0,"state":"String","source":"String","condition":"String","simpleRuleType":"Always","customerState":"String","flowId":"String","flowParams":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"isAllDay":false,"startDate":"String","startTime":"String","endTime":"String","bySetPosition":[0],"byMonth":[0],"byWeekNo":[0],"byYearDay":[0],"byMonthDay":[0],"byDay":[{"offset":0,"dayOfWeek":"Sunday"}],"byHour":[0],"byMinute":[0],"interval":0,"count":0,"untilDate":"String","frequency":"None"}],"defaultState":"String"},"integrationData":{"String":{"thirdPartyId":"String"}},"overrideBillingSettings":false,"billingSettings":{"base":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"localNumbers":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"tollFreeNumbers":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundVoiceCalls":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundVoiceCalls":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundFaxes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundFaxes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundSmsMessages":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundSmsMessages":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0}},"overrideAppSettings":false,"appSettings":{"enablePhoneNumberManagement":false,"enableDeviceManagement":false,"enableDialer":false,"enableCallHistory":false,"showFileNameInMessageCenter":false,"chakraTheme":"String","customCss":"String","pageTitle":"String","stringMappings":"String","logoutUrl":"String","portMyNumberUrl":"String"},"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"totalCount":0,"totalPages":0,"hasMorePages":false}