---
title: "Get user"
method: GET
path: "/v1/users/{identifyId}"
tags: ["Users"]
---

# Get user

`GET /v1/users/{identifyId}`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/users/{identifyId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/users/:identifyId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the user with the given id

## Path parameters

- `identifyId` string, required

## Response `200`

Success

- User: User object
  - `aptrinsicId` string
  - `identifyId` string, required
  - `type` 'LEAD' | 'USER' | 'VISITOR' | 'EMPTY_USER_TYPE'
  - `gender` 'MALE' | 'FEMALE' | 'OTHER' | 'EMPTY_GENDER'
  - `email` string
  - `firstName` string
  - `lastName` string
  - `lastSeenDate` integer
  - `signUpDate` integer
  - `firstVisitDate` integer
  - `title` string
  - `phone` string
  - `score` integer
  - `role` string
  - `subscriptionId` string
  - `accountId` string
  - `numberOfVisits` integer
  - `location` Location: Location 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` Coordinates: Coordinates object
      - `latitude` number, double
      - `longitude` number, double
  - `propertyKeys` string[], required: Aptrinsic Tag Key, at least one is required
  - `createDate` integer
  - `lastModifiedDate` integer
  - `customAttributes` object: Map of apiName to value
  - `globalUnsubscribe` boolean
  - `sfdcContactId` string
  - `channelMetricList` ChannelMetric[]
    - `groupId` string
    - `channel` integer
    - `environment` integer
    - `firstSeenDate` integer
    - `lastSeenDate` integer
  - `lastVisitedUserAgentData` UserAgentByProduct[]
    - `propertyKey` string
    - `userAgent` UserAgent: User Agent object
      - `rawUserAgent` string
      - `device` string
      - `platformType` string
      - `platformVersion` string
      - `browserType` string
      - `browserVersion` string
  - `id` string: Synonym for identifyId, output only, not filterable
  - `lastInferredLocation` Location: Location 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` Coordinates: Coordinates object
      - `latitude` number, double
      - `longitude` number, double
  - `globalId` string: Global user ID, only applicable for workspace-enabled subscriptions

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `404`: User not found
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api.md) - [All operations](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/revisions/e7b197b373d8?raw)