Mercury: Users schemas
2 Mercury schemas with complete fields and constraints.
← Users operations · All schemas
Get all users — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response containing a list of organization users. |
page | object | Required within parent | Pagination information including cursors for navigating to next/previous pages |
page.nextPage | string | Optional | ID for the user Format: uuid |
page.previousPage | string | Optional | ID for the user Format: uuid |
users | array | Required within parent | List of users in the current page |
users[] | Model | Each item | Expand Get user by ID — response body |
Referenced models: Get user by ID — response body
Get user by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a user within an organization. |
email | string | Required within parent | User's email address |
firstName | string | Required within parent | User's first name Maximum length: 299 Minimum length: 1 |
lastName | string | Required within parent | User's last name Maximum length: 299 Minimum length: 1 |
organizationRole | JSON | Required within parent | |
organizationRole (allOf 1) | string | All variants apply | Known values: administrator, bookkeeper, customUser, cardOnlyUser, employee |
organizationRole (allOf 2) | JSON | All variants apply | User's role within the organization |
userId | JSON | Required within parent | |
userId (allOf 1) | string | All variants apply | ID for the user Format: uuid |
userId (allOf 2) | JSON | All variants apply | Unique identifier for the user |