Users

Get User by id

get/api/v4/users/{id}

Request

  • Base URL
    https://cabify-sandbox.com
  • URL
    https://cabify-sandbox.com/api/v4/users/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

ID of the User to search

Response

Success

can_manageboolean

Whether User is an admin or regular User

can_order_for_othersboolean

If true, user will be able to order journeys for others

default_charge_codestring

User's Default Charge Code

disabledboolean

Whether the User is enabled or disabled

emailstring email required

Email of User. Must be unique

email_ccstring[]

List of email addresses (for journey related emails only)

employee_codestring

User's Employee Code, useful to map with company's code

idstring required

id of the User, UUIDv4 format without hyphens

localestring

User's Locale. Syntax consists of language two-letter tag which then will be suffixed with Client's country, e.g.: es-ES

mobile_ccstring required

Mobile Country Code. Can be checked here: https://countrycode.org/

mobile_numstring required

Mobile Number of User

namestring required

Name of the User

permission_group_idstring nullable

User's TravelPolicy

surnamestring required

Surname of the User

Example response

{
  "email": "john.doe@example.com",
  "id": "9a0e2da7f93a4b24bce47a8b10d3997a",
  "mobile_cc": "34",
  "mobile_num": "612345678",
  "name": "John",
  "surname": "Doe"
}

Changes

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property pattern ^[a-f0-9]{32}$ was added for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status