GET /v1/users/{identifyId}

Retrieves the user with the given id

Path parameters

  • identifyId string Required

    User id (from identify call)

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes 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

  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 404

    User not found

  • 429

    Rate limit exceeded

GET /v1/users/{identifyId}
curl \
 --request GET 'https://api.aptrinsic.com/v1/users/{identifyId}'
Response examples (200)
{
  "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"
}