Users

A user is an individual with access to Atono, identified by a unique email address. You can retrieve information about a user, such as their name, invitation status, and account timestamps.

User attributes

The table below lists the fields available on users, including those you can specify when adding a user or updating their details, as well as fields returned in API responses.

The Usage column shows which endpoints accept values for that field. If the Usage column is blank, the field is read-only—it's returned in responses but can't be manually specified in any request.

Field	Type	Description	Usage
`createdAt`	datetime (ISO 8601)	The date and time the user account was created.
`updatedAt`	datetime (ISO 8601)	The date and time the user’s information (e.g., name, status, or roles) was last updated.
`invitedAt`	datetime (ISO 8601)	The date and time the user was sent an invitation to join the workspace.
`email`	string	The user’s email address. Must be unique across all users.	POST
`fullName`	string	The user’s full name, entered as a single field.	POST, PATCH
`deleted`	boolean	Indicates whether the user has been deleted.

Example: Get a user

This example shows a GET response for a single user, including their ID, metadata, and contact details.

{
  "data": {
    "type": "user",
    "id": "fe4641d7-c72a-4165-904d-89b2ded40916",
    "attributes": {
      "createdAt": "2024-08-10T00:45:55Z",
      "updatedAt": "2024-08-10T00:46:58Z",
      "invitedAt": "2025-01-23T22:58:21Z",
      "email": "[email protected]",
      "fullName": "Oliver Resonance",
      "deleted": false
    }
  },
  "links": {
    "self": "/api/v1/users/fe4641d7-c72a-4165-904d-89b2ded40916"
  }
}

Example: Add a user

This example shows a POST request to add a new user by specifying their email and full name.

{
  "data": {
    "type": "user",
    "attributes": {
      "email": "[email protected]",
      "fullName": "Carla Clave"
    }
  }
}