Within Revenue HQ, user records relate to individuals who are authorized to perform specific actions on behalf of an application.
Users have login credentials to, and a direct relationship with, Revenue HQ. This is distinct from individuals who sign up for an application. An individual who enters into a billing relationship with an application is called an Account.
One particular user might be invited to work on multiple applications (e.g., bookkeepers, marketing agencies, contractors, etc). Because users exist in Revenue HQ outside of any one application, API calls to retrieve, modify, manage API tokens, etc. of a user are only possible to the authenticated user acting on his or her own behalf. You cannot modify another user's record.
That said, you can add, remove, and update the scopes of users authorized to manage your application.
Attributes:
| Name | Type | Description |
|---|---|---|
| id | string | V7 UUID generated when the user record is created. |
| name | string | The user's full name. |
| string | The user's email address. | |
| api_tokens | array | Array of User API Tokens. |
| session_token | string | A short-lived JSON web token that identifies the authenticated user. See User Sessions. |
| scopes | array | Array of Scopes . |
| created_at | integer | Unix timestamp of when the user was created (in seconds since the Unix epoch). |
| updated_at | integer | Unix timestamp of when the user was last updated (in seconds since the Unix epoch). |