Skip to content

Deel: API tokens schemas

8 Deel schemas with complete fields and constraints.

← API tokens operations · All schemas

Invalidate an API token — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the API token.
Format: uuid
statusstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootDetails of the invalidation.
reasonstringOptionalReason shown next to the invalidated token in the Developer Center.
Maximum length: 200

List API tokens — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe API tokens.
data[]ModelEach itemExpand Retrieve an API token — 200 response body — data
has_morebooleanRequired within parentTrue when there is another page after this one.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page; null when there are no more results.
next_cursor (anyOf 2)nullAlternativeCursor for the next page; null when there are no more results.
total_countJSONRequired within parent
total_count (anyOf 1)JSONAlternative
total_count (anyOf 1) (anyOf 1)integerAlternativeTokens matching the filters across all pages; null on pages fetched with a cursor.
total_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_count (anyOf 2)nullAlternativeTokens 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeWhen the token was created.
Format: date-time
created_at (anyOf 2)nullAlternativeWhen the token was created.
Format: date-time
created_byJSONRequired within parentWho created, or now owns, the token. Null for tokens created before owners were recorded.
created_by (anyOf 1)ModelAlternativeExpand Retrieve an API token — 200 response body — data / created_by / status: ACTIVE, LEFT
created_by (anyOf 2)nullAlternative
expires_atJSONRequired within parent
expires_at (anyOf 1)stringAlternativeWhen the token expires; null when it never expires.
Format: date-time
expires_at (anyOf 2)nullAlternativeWhen the token expires; null when it never expires.
Format: date-time
group_idsarrayRequired within parentGroups the token is limited to; empty when it is not limited.
group_ids[]JSONEach item
group_ids[] (anyOf 1)integerAlternative
group_ids[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentUnique identifier of the API token.
Format: uuid
integrationJSONRequired within parent
integration (anyOf 1)stringAlternativeIntegration the token was created for, if any.
integration (anyOf 2)nullAlternativeIntegration the token was created for, if any.
invalidated_atJSONRequired within parent
invalidated_at (anyOf 1)stringAlternativeWhen the token was invalidated.
Format: date-time
invalidated_at (anyOf 2)nullAlternativeWhen the token was invalidated.
Format: date-time
invalidated_byJSONRequired within parentWho invalidated the token. Null unless it was invalidated.
invalidated_by (anyOf 1)ModelAlternativeExpand Retrieve an API token — 200 response body — data / invalidated_by / status: ACTIVE, LEFT
invalidated_by (anyOf 2)nullAlternative
invalidation_reasonJSONRequired within parent
invalidation_reason (anyOf 1)stringAlternativeReason given when the token was invalidated.
invalidation_reason (anyOf 2)nullAlternativeReason given when the token was invalidated.
is_stalebooleanRequired within parentTrue when the token is usable but has not been used for 60 days.
labelstringRequired within parentName given to the token when it was created.
last_used_atJSONRequired within parent
last_used_at (anyOf 1)stringAlternativeWhen the token last called the API.
Format: date-time
last_used_at (anyOf 2)nullAlternativeWhen the token last called the API.
Format: date-time
scopesarrayRequired within parentScopes the token was granted.
scopes[]stringEach item
should_hide_employment_databooleanRequired within parentTrue when responses to this token omit employment data.
should_hide_pii_databooleanRequired within parentTrue when responses to this token omit personal data.
statusstringRequired within parentWhere the token is in its lifecycle. `EXPIRING` means it expires within 14 days.
Known values: ACTIVE, EXPIRING, EXPIRED, INVALIDATED
token_typestringRequired 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

FieldTypePresenceDescription and constraints
$objectRootWho created, or now owns, the token. Null for tokens created before owners were recorded.
emailJSONRequired within parent
email (anyOf 1)stringAlternativeEmail of the person, when known.
email (anyOf 2)nullAlternativeEmail of the person, when known.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeFull name of the person, when known.
name (anyOf 2)nullAlternativeFull name of the person, when known.
profile_idstringRequired within parentProfile id of the person.
statusstringRequired 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

FieldTypePresenceDescription and constraints
$objectRootWho invalidated the token. Null unless it was invalidated.
emailJSONRequired within parent
email (anyOf 1)stringAlternativeEmail of the person, when known.
email (anyOf 2)nullAlternativeEmail of the person, when known.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeFull name of the person, when known.
name (anyOf 2)nullAlternativeFull name of the person, when known.
profile_idstringRequired within parentProfile id of the person.
statusstringRequired within parent`LEFT` when the person no longer belongs to the organization.
Known values: ACTIVE, LEFT

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.