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.

Query parameters

filter array[string]

Filters
pageSize integer(int32)

Number of users per page

Minimum value is 1, maximum value is 1000. Default value is 25.
scrollId string

Used for fetching subsequent pages after the first one. Returned in response.scrollId
sort string

Sort fields

Responses

200 */*

Success
Hide response attributes Show response attributes object
- users array[object]
  
  Array of users
  
  Hide users attributes Show users attributes object
  
  User object
  
  aptrinsicId string
  
  identifyId string Required
  
  type string
  
  Values are LEAD, USER, VISITOR, or EMPTY_USER_TYPE.
  
  gender string
  
  Values are MALE, FEMALE, OTHER, or EMPTY_GENDER.
  
  email string
  
  firstName string
  
  lastName string
  
  lastSeenDate integer(int64)
  
  signUpDate integer(int64)
  
  firstVisitDate integer(int64)
  
  title string
  
  phone string
  
  score integer(int64)
  
  role string
  
  subscriptionId string
  
  accountId string
  
  numberOfVisits integer(int32)
  
  location object
  
  Location object
  
  Hide location attributes Show location attributes object
  
  countryName string
  
  countryCode string
  
  See ISO 3166
  
  stateName string
  
  stateCode string
  
  See ISO 3166
  
  city string
  
  street string
  
  postalCode string
  
  continent string
  
  See ISO 3166
  
  regionName string
  
  See ISO 3166-2
  
  timeZone string
  
  coordinates object
  
  Coordinates object
  
  Hide coordinates attributes Show coordinates attributes object
  
  latitude number(double)
  
  longitude number(double)
  
  propertyKeys array[string] Required
  
  Aptrinsic Tag Key, at least one is required
  
  createDate integer(int64)
  
  lastModifiedDate integer(int64)
  
  customAttributes object
  
  Map of apiName to value
  
  globalUnsubscribe boolean
  
  sfdcContactId string
  
  channelMetricList array[object]
  
  Hide channelMetricList attributes Show channelMetricList attributes object
  
  Channel metric object
  
  groupId string
  
  channel integer(int64)
  
  environment integer(int32)
  
  firstSeenDate integer(int64)
  
  lastSeenDate integer(int64)
  
  lastVisitedUserAgentData array[object]
  
  Hide lastVisitedUserAgentData attributes Show lastVisitedUserAgentData attributes object
  
  User Agent data by product
  
  propertyKey string
  
  userAgent object
  
  User Agent object
  
  Hide userAgent attributes Show userAgent attributes object
  
  rawUserAgent string
  
  device string
  
  platformType string
  
  platformVersion string
  
  browserType string
  
  browserVersion string
  
  id string
  
  Synonym for identifyId, output only, not filterable
  
  lastInferredLocation object
  
  Location object
  
  Hide lastInferredLocation attributes Show lastInferredLocation attributes object
  
  countryName string
  
  countryCode string
  
  See ISO 3166
  
  stateName string
  
  stateCode string
  
  See ISO 3166
  
  city string
  
  street string
  
  postalCode string
  
  continent string
  
  See ISO 3166
  
  regionName string
  
  See ISO 3166-2
  
  timeZone string
  
  coordinates object
  
  Coordinates object
  
  Hide coordinates attributes Show coordinates attributes object
  
  latitude number(double)
  
  longitude number(double)
  
  globalId string
  
  Global user ID, only applicable for workspace-enabled subscriptions
- 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

GET /v1/users

curl \
 --request GET 'https://api.aptrinsic.com/v1/users'

Response examples (200)

{
  "users": [
    {
      "aptrinsicId": "string",
      "identifyId": "string",
      "type": "LEAD",
      "gender": "MALE",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "lastSeenDate": 42,
      "signUpDate": 42,
      "firstVisitDate": 42,
      "title": "string",
      "phone": "string",
      "score": 42,
      "role": "string",
      "subscriptionId": "string",
      "accountId": "string",
      "numberOfVisits": 42,
      "location": {
        "countryName": "United States",
        "countryCode": "USA",
        "stateName": "California",
        "stateCode": "CA",
        "city": "San Mateo",
        "street": "101 Broadway",
        "postalCode": 94010,
        "continent": "NA",
        "regionName": "string",
        "timeZone": "string",
        "coordinates": {
          "latitude": 37.567147,
          "longitude": -122.324211
        }
      },
      "propertyKeys": [
        "AP-XXXXXXXXXX-2"
      ],
      "createDate": 42,
      "lastModifiedDate": 42,
      "customAttributes": {},
      "globalUnsubscribe": true,
      "sfdcContactId": "string",
      "channelMetricList": [
        {
          "groupId": "string",
          "channel": 42,
          "environment": 42,
          "firstSeenDate": 42,
          "lastSeenDate": 42
        }
      ],
      "lastVisitedUserAgentData": [
        {
          "propertyKey": "string",
          "userAgent": {
            "rawUserAgent": "string",
            "device": "string",
            "platformType": "string",
            "platformVersion": "string",
            "browserType": "string",
            "browserVersion": "string"
          }
        }
      ],
      "id": "string",
      "lastInferredLocation": {
        "countryName": "United States",
        "countryCode": "USA",
        "stateName": "California",
        "stateCode": "CA",
        "city": "San Mateo",
        "street": "101 Broadway",
        "postalCode": 94010,
        "continent": "NA",
        "regionName": "string",
        "timeZone": "string",
        "coordinates": {
          "latitude": 37.567147,
          "longitude": -122.324211
        }
      },
      "globalId": "string"
    }
  ],
  "totalHits": 42,
  "scrollId": "string"
}