---
title: "Get a user"
method: GET
path: "/Users/{id}"
---

# Get a user

`GET /Users/{id}`

## Request

- Base URL: `https://app.perk.com/api/v2/scim`
- URL: `https://app.perk.com/api/v2/scim/Users/{id}`
- Auth: API key in header `Authorization`

Retrieves a user from Perk.

## Path parameters

- `id` integer, required

## Response `200`

Returns `200 OK` and the user resource.

- object
  - `schemas` string[]
  - `name` object: The components of the user's real name
    - `givenName` string: Given name (first name)
    - `familyName` string: Family name (last name)
    - `middleName` string: Middle name(s)
    - `honorificPrefix` string: Honorific prefix (e.g. Mr, Mrs, Ms)
  - `locale` string: User's locale for currency, date/time, and numerical formats. Defaults to `en` for British English. Use `en-us` for American English
  - `preferredLanguage` string: User's preferred written or spoken language
  - `title` string: The user's job title
  - `externalId` string: Unique identifier for the user in the client system
  - `id` string: Perk-generated identification number. Read-only
  - `groups` unknown[]: Groups — currently not supported by Perk. Always returns an empty array
    - unknown
  - `active` boolean: Whether the user is administratively active
  - `userName` string: User's email address. Must be a valid, non-empty email address and unique across all users in Perk
  - `phoneNumbers` object[]
    - `value` string: Phone number of the user
    - `type` string: Label indicating the type of phone number. Accepted values: `work`, `home`, `mobile`, `fax`, `pager`, `other`
  - `meta` object: Server-generated metadata. Read-only
    - `resourceType` string: The name of the resource type
    - `created` string: Date-time the resource was added to the service provider
    - `lastModified` string: Date-time when the resource was last updated
    - `location` string: URI of the resource.
  - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` object: Enterprise User schema extension. Schema URN: `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User`
    - `costCenter` string: Name of the cost object. It must already exist in Perk
  - `urn:ietf:params:scim:schemas:extension:travelperk:2.0:User` object: Perk custom user schema extension. Schema URN: `urn:ietf:params:scim:schemas:extension:travelperk:2.0:User`
    - `gender` string: User's gender as used in travel documents. Accepted values: `M` (male), `F` (female)
    - `dateOfBirth` string: Date of birth in `YYYY-MM-DD` format. Any other format is rejected
    - `travelPolicy` string: Name of the travel policy. It must already exist in Perk
    - `invoiceProfiles` object[]: Invoice profiles to assign to the user (typically one). Each must already exist in Perk. For `add` PATCH operations, new values are appended to the existing list
      - `value` string: Payment profile name. It must already exist in Perk
    - `company` string: Company that the user belongs to (legal entity). If not provided, Perk assigns the user to the default company
    - `emergencyContact` object: The user's emergency contact
      - `name` string: Full name of the emergency contact
      - `phone` string: Phone number of the emergency contact
    - `approvers` object[]: Deprecated. Use `manager` or `lineManagerEmail` instead. For `add` PATCH operations, new values are appended to the existing list
      - `value` string: The approver's Perk user ID
      - `$ref` string: URI that refers to the approver within Perk. Maps to the SCIM `$ref` attribute in API responses
      - `displayName` string: Human-readable name of the approver
      - `condition` string: Approval process condition. Accepted values: `always`, `out_of_policy`, `out_of_policy_and_notify_in_policy`, `in_policy`
    - `countryOfResidence` string: Country of residence (ISO 3166-1 alpha-2 code)
    - `travelDocuments` object[]: Travel documents for the user
      - `documentType` string: Type of document: `passport` or `id`
      - `documentNumber` string: The number of the document
      - `givenName` string: First name as it appears on the document
      - `middleName` string: Middle name as it appears on the document
      - `familyName` string: Last name as it appears on the document
      - `gender` string: Gender as it appears on the document
      - `issuingCountry` string: Country where the document was issued (ISO 3166-1 alpha-2 code)
      - `issuingDate` string: Date the document was issued (YYYY-MM-DD)
      - `expirationDate` string: Expiration date of the document (YYYY-MM-DD)
      - `citizenship` string: Citizenship as stated in the document (ISO 3166-1 alpha-2 code)
  - `urn:ietf:params:scim:schemas:extension:expense:2.0:User` object: Expense User schema extension. Schema URN: `urn:ietf:params:scim:schemas:extension:expense:2.0:User`
    - `policyId` string: ID of the expense policy assigned to the user
    - `creditor` string: Name of the creditor (company) used for expense reimbursements
    - `legalEntityId` string: ID of the company the user belongs to for expense purposes
    - `approvalThreshold` number, double: Maximum expense amount (in the account currency) the user can approve without a secondary approver
    - `ignoreManagerInRequests` boolean: If `true`, the user's manager is excluded from expense approval requests

## Other responses

- `404`: Returns `404 Not found` and a SCIM error when no user matches the ID.

---

[API](https://skmtc.dev/perk/apis/scim-server.md) - [All operations](https://skmtc.dev/perk/apis/scim-server/llms.txt) - [OpenAPI document](https://skmtc.dev/perk/apis/scim-server/revisions/cd90f1acd9e2?raw)