# Get users

**GET /v1/users**

Retrieves users.  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/users?filter=lastName==Doe;firstName==John | Users with firstName of 'John' AND lastName of 'Doe'. |
| GET /v1/users?filter=firstName==John;lastName=Doe&filter=firstName==Bob | Users with: (firstName of 'John' AND lastName of 'Doe') OR firstName of 'Bob'. |
| GET /v1/users?filter=location.cityName==Portland | Users with a city of 'Portland'. |
| GET /v1/users?filter=customAttributes.internalId==12345 | Users with a custom attribute of internalId equal to 12345'. |
| GET /v1/users?filter=lastInferredLocation.stateName==Georgia | Users with a last inferred location.stateName value of Georgia'. |
| GET /v1/users?filter=lastVisitedUserAgentData.userAgent.browserType==firefox | Users with firefox as last visited browser across the products '. |
| GET /v1/users?filter=lastVisitedUserAgentData.userAgent.browserType==firefox;lastVisitedUserAgentData.propertyKey==AP-8MF5LPSWUBFW-2 | Users with firefox as last visited browser for a particular product(with property key AP-8MF5LPSWUBFW-2)'. |

#### Supported filter fields for last inferred location
| Field   |
| ----- |
| lastInferredLocation.countryCode |
| lastInferredLocation.countryName |
| lastInferredLocation.stateCode |
| lastInferredLocation.stateName |
| lastInferredLocation.city |
| lastInferredLocation.continent |
| lastInferredLocation.postalCode |
| lastInferredLocation.regionName |
| lastInferredLocation.timeZone |
| lastInferredLocation.street |


### 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/users?sort=lastName;firstName | Users sorted by firstName, lastName, in ascending order. |
| GET /v1/users?sort=-createDate | Users 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 users per page
- **scrollId** (string)
  Used for fetching subsequent pages after the first one.  Returned in response.scrollId
- **sort** (string)
  Sort fields


## Responses
### 200
Success

#### Body: */* (object)
- **users** (array[object])
  Array of users
- **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)