# Get accounts

**GET /v1/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. |




## Servers
- https://api.aptrinsic.com: https://api.aptrinsic.com ()



## Parameters


### Query parameters
- **filter** (array[string])
  Filters
- **pageSize** (integer(int32))
  Number of accounts per page
- **scrollId** (string)
  Used for fetching subsequent pages after the first one.  Returned in response.scrollId
- **sort** (string)
  Sort


## Responses
### 200
Success

#### Body: */* (object)
- **accounts** (array[object])
  Array of accounts
- **totalHits** (integer(int64))
  Total number of records matching filters
- **scrollId** (string)
  If passed on subsequent requests as the scrollId parameter, will fetch the next page

### 400
Bad request

### 401
Unauthorized or bad API Key

### 429
Rate limit exceeded


[Powered by Bump.sh](https://bump.sh)