Deel: API tokens schemas
8 Deel schemas with complete fields and constraints.
← API tokens operations · All schemas
Invalidate an API token — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Invalidate an API token — 200 response body — data |
Referenced models: Invalidate an API token — 200 response body — data
Invalidate an API token — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the API token. Format: uuid |
status | string | Required within parent | The token no longer authenticates: `INVALIDATED`, or `EXPIRED` when it had already expired and was left unchanged. Known values: INVALIDATED, EXPIRED |
Invalidate an API token — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the invalidation. |
reason | string | Optional | Reason shown next to the invalidated token in the Developer Center. Maximum length: 200 |
List API tokens — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The API tokens. |
data[] | Model | Each item | Expand Retrieve an API token — 200 response body — data |
has_more | boolean | Required within parent | True when there is another page after this one. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page; null when there are no more results. |
next_cursor (anyOf 2) | null | Alternative | Cursor for the next page; null when there are no more results. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | JSON | Alternative | |
total_count (anyOf 1) (anyOf 1) | integer | Alternative | Tokens matching the filters across all pages; null on pages fetched with a cursor. |
total_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count (anyOf 2) | null | Alternative | Tokens matching the filters across all pages; null on pages fetched with a cursor. |
Referenced models: Retrieve an API token — 200 response body — data
Retrieve an API token — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve an API token — 200 response body — data |
Referenced models: Retrieve an API token — 200 response body — data
Retrieve an API token — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | When the token was created. Format: date-time |
created_at (anyOf 2) | null | Alternative | When the token was created. Format: date-time |
created_by | JSON | Required within parent | Who created, or now owns, the token. Null for tokens created before owners were recorded. |
created_by (anyOf 1) | Model | Alternative | Expand Retrieve an API token — 200 response body — data / created_by / status: ACTIVE, LEFT |
created_by (anyOf 2) | null | Alternative | |
expires_at | JSON | Required within parent | |
expires_at (anyOf 1) | string | Alternative | When the token expires; null when it never expires. Format: date-time |
expires_at (anyOf 2) | null | Alternative | When the token expires; null when it never expires. Format: date-time |
group_ids | array | Required within parent | Groups the token is limited to; empty when it is not limited. |
group_ids[] | JSON | Each item | |
group_ids[] (anyOf 1) | integer | Alternative | |
group_ids[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Unique identifier of the API token. Format: uuid |
integration | JSON | Required within parent | |
integration (anyOf 1) | string | Alternative | Integration the token was created for, if any. |
integration (anyOf 2) | null | Alternative | Integration the token was created for, if any. |
invalidated_at | JSON | Required within parent | |
invalidated_at (anyOf 1) | string | Alternative | When the token was invalidated. Format: date-time |
invalidated_at (anyOf 2) | null | Alternative | When the token was invalidated. Format: date-time |
invalidated_by | JSON | Required within parent | Who invalidated the token. Null unless it was invalidated. |
invalidated_by (anyOf 1) | Model | Alternative | Expand Retrieve an API token — 200 response body — data / invalidated_by / status: ACTIVE, LEFT |
invalidated_by (anyOf 2) | null | Alternative | |
invalidation_reason | JSON | Required within parent | |
invalidation_reason (anyOf 1) | string | Alternative | Reason given when the token was invalidated. |
invalidation_reason (anyOf 2) | null | Alternative | Reason given when the token was invalidated. |
is_stale | boolean | Required within parent | True when the token is usable but has not been used for 60 days. |
label | string | Required within parent | Name given to the token when it was created. |
last_used_at | JSON | Required within parent | |
last_used_at (anyOf 1) | string | Alternative | When the token last called the API. Format: date-time |
last_used_at (anyOf 2) | null | Alternative | When the token last called the API. Format: date-time |
scopes | array | Required within parent | Scopes the token was granted. |
scopes[] | string | Each item | |
should_hide_employment_data | boolean | Required within parent | True when responses to this token omit employment data. |
should_hide_pii_data | boolean | Required within parent | True when responses to this token omit personal data. |
status | string | Required within parent | Where the token is in its lifecycle. `EXPIRING` means it expires within 14 days. Known values: ACTIVE, EXPIRING, EXPIRED, INVALIDATED |
token_type | string | Required within parent | `PERSONAL` tokens act as the person who created them; `ORGANIZATION` tokens act for the whole organization. Known values: PERSONAL, ORGANIZATION |
Referenced models: Retrieve an API token — 200 response body — data / created_by / status: ACTIVE, LEFT, Retrieve an API token — 200 response body — data / invalidated_by / status: ACTIVE, LEFT
Retrieve an API token — 200 response body — data / created_by / status: ACTIVE, LEFT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Who created, or now owns, the token. Null for tokens created before owners were recorded. |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | Email of the person, when known. |
email (anyOf 2) | null | Alternative | Email of the person, when known. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Full name of the person, when known. |
name (anyOf 2) | null | Alternative | Full name of the person, when known. |
profile_id | string | Required within parent | Profile id of the person. |
status | string | Required within parent | `LEFT` when the person no longer belongs to the organization. Known values: ACTIVE, LEFT |
Retrieve an API token — 200 response body — data / invalidated_by / status: ACTIVE, LEFT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Who invalidated the token. Null unless it was invalidated. |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | Email of the person, when known. |
email (anyOf 2) | null | Alternative | Email of the person, when known. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Full name of the person, when known. |
name (anyOf 2) | null | Alternative | Full name of the person, when known. |
profile_id | string | Required within parent | Profile id of the person. |
status | string | Required within parent | `LEFT` when the person no longer belongs to the organization. Known values: ACTIVE, LEFT |