Skip to content

Mercury: Users schemas

2 Mercury schemas with complete fields and constraints.

← Users operations · All schemas

Get all users — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response containing a list of organization users.
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the user
Format: uuid
page.previousPagestringOptionalID for the user
Format: uuid
usersarrayRequired within parentList of users in the current page
users[]ModelEach itemExpand Get user by ID — response body

Referenced models: Get user by ID — response body

Get user by ID — response body

FieldTypePresenceDescription and constraints
$objectRootDetails of a user within an organization.
emailstringRequired within parentUser's email address
firstNamestringRequired within parentUser's first name
Maximum length: 299
Minimum length: 1
lastNamestringRequired within parentUser's last name
Maximum length: 299
Minimum length: 1
organizationRoleJSONRequired within parent
organizationRole (allOf 1)stringAll variants applyKnown values: administrator, bookkeeper, customUser, cardOnlyUser, employee
organizationRole (allOf 2)JSONAll variants applyUser's role within the organization
userIdJSONRequired within parent
userId (allOf 1)stringAll variants applyID for the user
Format: uuid
userId (allOf 2)JSONAll variants applyUnique identifier for the user

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.