PEperk

Get a user

Retrieves a user from Perk.

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

Path parameters

idinteger required

Unique user identifier. The value is generated by Perk and returned during user creation.

Response

Returns 200 OK and the user resource.

schemasstring[]
localestring

User's locale for currency, date/time, and numerical formats. Defaults to en for British English. Use en-us for American English

preferredLanguagestring

User's preferred written or spoken language

titlestring

The user's job title

externalIdstring

Unique identifier for the user in the client system

idstring

Perk-generated identification number. Read-only

activeboolean

Whether the user is administratively active

userNamestring

User's email address. Must be a valid, non-empty email address and unique across all users in Perk

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "name": {
    "givenName": "Marlen",
    "familyName": "Col"
  },
  "locale": "en",
  "preferredLanguage": "en",
  "title": "Manager",
  "externalId": "123455667",
  "id": "29",
  "active": true,
  "userName": "marlen.col@mycompany.com",
  "phoneNumbers": [
    {
      "value": "+34 1234567",
      "type": "work"
    }
  ],
  "meta": {
    "resourceType": "User",
    "created": "2020-04-01T22:24:44.137082+00:00",
    "lastModified": "2020-04-01T22:24:44.137082+00:00",
    "location": "http://app.perk.com/api/v2/scim/Users/29"
  },
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "costCenter": "Marketing"
  },
  "urn:ietf:params:scim:schemas:extension:travelperk:2.0:User": {
    "gender": "M",
    "dateOfBirth": "1980-02-02",
    "travelPolicy": "Marketing travel policy",
    "invoiceProfiles": [
      {
        "value": "My Company Ltd"
      }
    ],
    "company": "MyCompany USA, Ltd",
    "emergencyContact": {
      "name": "Jane Goodie",
      "phone": "+34 9874637"
    },
    "approvers": [
      {
        "value": "123",
        "$ref": "https://app.perk.com/api/v2/scim/Users/123/",
        "displayName": "Jack Jackson",
        "condition": "always"
      }
    ],
    "countryOfResidence": "ES",
    "travelDocuments": [
      {
        "documentType": "passport",
        "documentNumber": "abcedf12345",
        "givenName": "Josh",
        "familyName": "Smith",
        "gender": "M",
        "issuingCountry": "ES",
        "issuingDate": "1999-12-05",
        "expirationDate": "2042-09-08",
        "citizenship": "ES"
      }
    ]
  },
  "urn:ietf:params:scim:schemas:extension:expense:2.0:User": {
    "policyId": "pol_123",
    "creditor": "ACME Corp",
    "legalEntityId": "le_456",
    "approvalThreshold": 1000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.