# Users

### The User object

| Attribute   | Type   | Description                                                                              |
| ----------- | ------ | ---------------------------------------------------------------------------------------- |
| id          | string | Unique user identifier                                                                   |
| name        | string | Full name of the user                                                                    |
| email       | string | Email address associated with the user                                                   |
| is\_active  | bool   | Indicator whether the user is active or not. Inactive users cannot sign into Simple OKR. |
| created\_at | string | Time when the user was created. RFC 3339 format.                                         |

Example:

```javascript
{
  "id": "16682617-f25d-4df2-9f51-3c38298996b8",
  "name": "John Doe",
  "email": "email@example.com",
  "is_active": true,
  "created_at": "2018-02-20T12:32:56Z"
}
```

## List users

<mark style="color:blue;">`GET`</mark> `https://api.simpleokr.com/v1/users`

Returns a list of your users.

#### Query Parameters

| Name        | Type   | Description     |
| ----------- | ------ | --------------- |
| page\_token | string | Page identifier |

{% tabs %}
{% tab title="200 " %}

```javascript
{
  "next_page_token": null,
  "users": [
    {
      "id": "16682617-f25d-4df2-9f51-3c38298996b8",
      "name": "John Doe",
      "email": "email@example.com",
      "is_active": true,
      "created_at": "2018-02-20T12:32:56Z"
    },
    {...},
    {...}
  ]
}
```

{% endtab %}
{% endtabs %}

## Retrieve user

<mark style="color:blue;">`GET`</mark> `https://api.simpleokr.com/v1/users/:id`

Retrieve details about the existing user. Supply a unique user ID from a user list response.<br>

#### Path Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | string | User ID     |

{% tabs %}
{% tab title="200 " %}

```javascript
{
  "id": "16682617-f25d-4df2-9f51-3c38298996b8",
  "name": "John Doe",
  "email": "email@example.com",
  "is_active": true,
  "created_at": "2018-02-20T12:32:56Z"
}
```

{% endtab %}
{% endtabs %}