Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Users

Get user

This endpoint allows you to retrieve a user by their ID.

get/v1/businesses/{client_id}/users/{user_id}

Path parameters

client_idinteger required
Example:123

The ID of the business.

user_idinteger required

The ID of the user.

Response

OK

idinteger

The ID of the user.

first_namestring

The first name of the user.

last_namestring

The last name of the user.

namestring

The full name of the user or the display name if the user has set one.

emailstring email

The email of the user.

rolestring

The role of the user.

role_idstring uuid

The ID of the user's role.

is_deletedboolean

Whether the user is deleted.

createdstring date-time

The date and time when the user was created in UTC.

updatedstring date-time

The date and time when the user was last updated in UTC.

payment_typesPaymentType[]

The payment types the user can transact with.

out_of_office_modeboolean

Whether the user is out of office.

out_of_office_start_datestring date nullable

First day of the out-of-office period (inclusive).

out_of_office_end_datestring date nullable

Last day of the out-of-office period (inclusive).

delegate_approverinteger nullable

The user ID to delegate approvals to while out of office.

expense_delegateinteger[] nullable

The user IDs of this user's expense assistants (who can act on their expenses). Null if the business does not have the expense assistant feature.

Example response

{
  "id": 123,
  "first_name": "John",
  "last_name": "Doe",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "Team Member",
  "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-01T00:00:00Z",
  "payment_types": [
    "cards"
  ],
  "out_of_office_mode": true,
  "out_of_office_start_date": "2026-06-01",
  "out_of_office_end_date": "2026-06-15",
  "delegate_approver": 789,
  "expense_delegate": [
    456,
    789
  ]
}