PEperk

List all users

Changed on

Users listed in descending order of id.

get/users

Request

  • Base URL
    https://api.travelperk.com
  • URL
    https://api.travelperk.com/users
  • Auth
    API key in header Authorization

Query parameters

trip_idstring

Find Users travelling on a Trip with this id. A comma separated list of multiple ids is accepted.

offsetinteger

Pagination offset index, 0 based.

limitinteger

Pagination maximum number of elements to return. See more info in Pagination

user_idstring

Find a single user with this id

Response

200

limitinteger
offsetinteger
totalinteger

Example response

{
  "users": [
    {
      "id": "8",
      "user_name": "boss@test.com",
      "name": {
        "last_name": "Morrison",
        "first_name": "Boss",
        "title": "MR"
      },
      "preferred_language": "en",
      "locale": "en-gb",
      "active": true,
      "job_title": "Boss",
      "phone_numbers": [
        "+34 123456789"
      ],
      "emergency_contact": {
        "name": "Mrs. Morrison",
        "phone": "+34 987654321"
      },
      "email": "boss@test.com"
    }
  ],
  "limit": 10,
  "total": 2
}

Changes