# The user object

The user object is returned as part of the response body of each successful retrieve or update API call to the `/api/user` endpoint.

## Fields

| Field                                   | Type       | Description                                                                                                                                                                                         |
| --------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`type`**                              | `string`   | `users`                                                                                                                                                                                             |
| **`id`**                                | `string`   | The user unique identifier.                                                                                                                                                                         |
| links.**`self`**                        | `string`   | The user endpoint URL.                                                                                                                                                                              |
| attributes.**`email`**                  | `string`   | The user email.                                                                                                                                                                                     |
| attributes.**`first_name`**             | `string`   | The user first name.                                                                                                                                                                                |
| attributes.**`last_name`**              | `string`   | The user last name.                                                                                                                                                                                 |
| attributes.**`time_zone`**              | `string`   | The user preferred timezone.                                                                                                                                                                        |
| attributes.**`otp_required_for_login`** | `boolean`  | The user 2FA setting.                                                                                                                                                                               |
| attributes.**`created_at`**             | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**`updated_at`**             | `datetime` | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**`reference`**              | `string`   | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**`reference_origin`**       | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**`metadata`**               | `object`   | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |