Accounts
Get accounts
Retrieves accounts. Supports filtering, sorting and paging.
Filtering
The filter parameter accepts a list of semicolon-separated filters in the form: {fieldName}{operator}{fieldValue} Filter terms within a single filter parameter are joined by a logical AND. Separate filter parameters are joined by a logical OR.
Operators
| Operator | Meaning |
|---|---|
| == | Exact match |
| != | Not equal |
| < | Less than |
| <= | Less than or equal |
| > | Greater than |
| >= | Greater than or equal |
| ~ | Matches string, supports wildcard characters * and ? |
| !~ | Not like, supports wildcard characters * and ? |
Examples:
| URI | Results |
|---|---|
| GET /v1/accounts?filter=sicCode==64;numberOfEmployees>25 | Accounts with sicCode of 64 and more than 25 employees. |
| GET /v1/accounts?filter=sicCode==64;numberOfEmployees>25&filter=sicCode==63;numberOfEmployees>3000 | Accounts with: (sicCode of 64 AND more than 25 employees) OR (sicCode of 63 AND more than 3000 employees). |
| GET /v1/accounts?filter=location.cityName==Portland | Accounts with a city of 'Portland'. |
| GET /v1/accounts?filter=customAttributes.internalId==12345 | Accounts with a custom attribute of internalId equal to 12345'. |
Sorting
The sort parameter accepts a list of semi-colon separated fields names, each with an optional dash to imply descending sort order. Examples:
| URI | Results |
|---|---|
| GET /v1/accounts?sort=name;location.stateCode | Accounts sorted by name and state code in ascending order. |
| GET /v1/accounts?sort=-createDate | Accounts sorted by createDate in descending order. |
get/v1/accounts
Request
- Base URLhttps://app.aptrinsic.com
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
filterstring[]
Filters
pageSizeinteger
Number of accounts per page
scrollIdstring
Used for fetching subsequent pages after the first one. Returned in response.scrollId
sortstring
Sort
Response
Success
Example response
{
"accounts": [
{
"location": {
"countryName": "United States",
"countryCode": "USA",
"stateName": "California",
"stateCode": "CA",
"city": "San Mateo",
"street": "101 Broadway",
"continent": "NA",
"coordinates": {
"latitude": 37.567147,
"longitude": -122.324211
}
},
"propertyKeys": [
"AP-XXXXXXXXXX-2"
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.