Ramp: Fetch a user — response body
Fetch a user: response body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Fetch a user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_id | JSON | Required within parent | |
business_id (anyOf 1) | string | Alternative | Unique identifier of the company that the employee’s working for. Format: uuid |
business_id (anyOf 2) | null | Alternative | |
custom_fields | array | Required within parent | A list of custom fields of the user. Read only: true |
custom_fields[] | Model | Each item | Expand Fetch a user — response body — custom fields item |
department_id | JSON | Required within parent | |
department_id (anyOf 1) | string | Alternative | Unique identifier of the employee’s department Format: uuid |
department_id (anyOf 2) | null | Alternative | |
email | string | Optional | The employee’s email address |
employee_id | JSON | Required within parent | |
employee_id (anyOf 1) | string | Alternative | An alternative identifier for an employee, coming from external systems, which can be used in place of an email. |
employee_id (anyOf 2) | null | Alternative | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Unique identifier of business entity user is associated with. Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
first_name | string | Optional | First name of the employee |
id | string | Optional | Unique employee identifier Format: uuid |
is_manager | boolean | Required within parent | Whether the employee is a manager Read only: true |
last_name | string | Optional | Last name of the employee |
location_id | JSON | Required within parent | |
location_id (anyOf 1) | string | Alternative | Unique identifier of the employee’s location Format: uuid |
location_id (anyOf 2) | null | Alternative | |
manager_id | JSON | Required within parent | |
manager_id (anyOf 1) | string | Alternative | Unique identifier of the employee’s manager Format: uuid |
manager_id (anyOf 2) | null | Alternative | |
phone | JSON | Required within parent | |
phone (anyOf 1) | string | Alternative | The employee’s phone number Read only: true |
phone (anyOf 2) | null | Alternative | |
role | string | Optional | The employee’s role Known values: AUDITOR, BUSINESS_ADMIN, BUSINESS_BOOKKEEPER, BUSINESS_OWNER, BUSINESS_USER, GUEST_USER, IT_ADMIN, UNBUNDLED_ADMIN, UNBUNDLED_BOOKKEEPER, UNBUNDLED_OWNER, UNBUNDLED_USER |
scheduled_deactivation_date | JSON | Required within parent | |
scheduled_deactivation_date (anyOf 1) | string | Alternative | The date when the user is scheduled to be deactivated. Presented in ISO8601 format. Format: date-time |
scheduled_deactivation_date (anyOf 2) | null | Alternative | |
scheduled_invitation_date | JSON | Required within parent | |
scheduled_invitation_date (anyOf 1) | string | Alternative | The date when the user (currently in USER_DRAFT status) is scheduled to be invited to Ramp. Presented in ISO8601 format. Null if no invitation is scheduled. Format: date-time |
scheduled_invitation_date (anyOf 2) | null | Alternative | |
status | string | Required within parent | Known values: INVITE_EXPIRED, INVITE_PENDING, USER_ACTIVE, USER_DRAFT, USER_INACTIVE, USER_ONBOARDING, USER_SUSPENDED Read only: true |
Referenced models: Fetch a user — response body — custom fields item