Users represent different types of users of the system. These can be account administrators, or read only users.

The User object

Here's the information stored in the system about users:

  • id: Autogenerated UUID of the user in the system.
  • email: Email address of the user.
  • name: Name of the user.
  • role: Role of the user. This will be either "customer_read_only" or "customer_admin".
  • status: Status of the user. This can be "active" or "deactivated"
  • account_id: ID of the account that the user belongs to.

And this is what a user returned by the API might look like:

{
  id: "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
  email: "user@test.com",
  name: "Test User",
  role: "customer_read_only",
  status: "active",
  account_id: "293f191b-f2e6-4dde-bcab-00b10fdb8cf4"
}