| GET | /accounts |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NameFilter | query | string | No | Filter the results by name |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | form | int | No | The page of data to retrieve |
| All | form | bool | No | If you want all objects to be returned. This should be used with care |
| CountPerPage | form | int | No | The number per page to retrieve |
| SpecificIds | form | List<string> | No | Specific IDs |
| SortField | form | string | No | Specify a sort field |
| SortOrder | form | SortOrders | No | Specify a sort order |
| SimplifiedPaging | form | bool | No | Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array |
| Ascend | |
| Descend |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | The name of this account |
| ParentAccountId | form | string | No | The ID of this account's parent |
| TwilioAccountSid | form | string | No | The twilio account SID |
| AncestorIds | form | List<string> | No | The ancestors of this account. Useful for breadcrumbs |
| MaxPhoneNumbers | form | int | No | The max number of phone numbers this account can have |
| IsBYOA | form | bool | No | This account is BYOA |
| TrustHubProfileSid | form | string | No | TrustHub Profile Sid |
| LogoId | form | string | No | The ID of the logo file |
| LogoUri | form | string | No | The URI of the logo file |
| BillingSettings | form | BillingSettings | No | The billing settings for this account |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | The ID of the object |
| DateCreated | form | string | No | The date the object was created |
| DateLastModified | form | string | No | The date the object was last modified |
| CreatedBy | form | string | No | The user that created this object |
| LastModifiedBy | form | string | No | The user that last modified this object |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Base | form | BillingItem | No | |
| LocalNumbers | form | BillingItem | No | |
| TollFreeNumbers | form | BillingItem | No | |
| InboundVoiceCalls | form | BillingItem | No | |
| OutboundVoiceCalls | form | BillingItem | No | |
| InboundFaxes | form | BillingItem | No | |
| OutboundFaxes | form | BillingItem | No | |
| InboundSmsMessages | form | BillingItem | No | |
| OutboundSmsMessages | form | BillingItem | No | |
| AIInsights | form | BillingItem | No | |
| AILiveMinutes | form | BillingItem | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BaseCost | form | double | No | |
| RawUnitMultiplier | form | double | No | |
| UnitCost | form | double | No | |
| Allowance | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Items | form | List<AccountInfo> | No | The items |
| TotalCount | form | int | No | The total number of items |
| TotalPages | form | int | No | The total number of pages |
| HasMorePages | form | bool | No | Are there more pages of items? Used with simplified paging |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /accounts HTTP/1.1 Host: team.evovoice.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":[{"name":"String","parentAccountId":"String","twilioAccountSid":"String","ancestorIds":["String"],"maxPhoneNumbers":0,"isBYOA":false,"trustHubProfileSid":"String","logoId":"String","logoUri":"String","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},"aiInsights":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"aiLiveMinutes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0}},"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"totalCount":0,"totalPages":0,"hasMorePages":false}