HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get All Accounts

Query all your organization's accounts or ones that match criteria supplied in the available query parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

This is from the standard searching and sorting parameters. You can search within one or more of the attributes within the Account object. When search is specified but searchOn is not specified, the default fields searched on are accountName and customerOrgName.

int32

The index of the first result. If not specified, this is zero. (Optional)

int32

The number of results to return. If not specified, this will return 25 results. (Optional)

string

The string of text to search on. This can also be a regular expression, in which case you should set the isRegex flag to true (see below). (Optional)

boolean

When true, the search will only return results that begin with the specified search string. Otherwise, any match of the search string will be returned as a result. The default is false. (Optional)

boolean

When true, the search will only return results that end with the specified search string. Otherwise, any match of the search string will be returned as a result. The default is false. (Optional)

boolean

When true, the provided search string will be regarded as a regular expression and the search will return results matching the regular expression. The default is false. (Optional)

string

Comma-separated list of fields to sort on. This can also be input via Array Inputs (see above). (Optional)

string

Comma-separated list of ordering. Possible values are ASC and DESC. Default is ASC. If your sortOn contains multiple fields and you would like to order fields individually, you can pass in a comma-separated list here (or use Array Inputs, see above). For example, if your sortOn contained 5 fields, and your sortOrder contained ASC,DESC,DESC, these would be applied to the first three items in the sortOn field. The remaining two would default to ASC. (Optional)

string

Pass in ext to obtain maximum fields in response

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json