The user object
A unique identifier for the user. This ID should match the user’s identifier in your system.
The object type identifier. Always set to “user” to distinguish it from other API objects.
A collection of user attributes. You can include any custom attributes to describe the user. See Attributes for details.
The timestamp when the user was created in the system, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Note: This is not the user’s signup time in your application - use a custom attribute like signed_up_at
for that.
A list of company objects that the user belongs to. This field is useful when you only need company information without membership details. If you need membership attributes (like roles or permissions), use the memberships
field instead. Can be expanded using ?expand=companies
.
A list of company membership objects representing the user’s company memberships. Each membership includes:
- Company-specific attributes (e.g., role, access level)
- Reference to the associated company object
Available expansion options:
?expand=memberships
: Include basic membership data?expand=memberships.company
: Include both membership and company details