Skip to content

Deel: Retrieve an API token

Deel apiTokens.getApiToken: arguments, response, policy and SDK examples.

← API tokens operations · Get started

Operation deel.apitokens_getapitoken_v2026_11_05

Provider route: GET /api-tokens/{token_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["apiTokens"]["getApiToken"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.apiTokens.getApiToken(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.api_tokens.get_api_token(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.token_idstringRequired within parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve an API token — 200 response body

Referenced models: Retrieve an API token — 200 response body

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

SDK function policy ID: deel.apitokens_getapitoken_v2026_11_05. Catalog operation: apitokens_getapitoken_v2026_11_05. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["tokens:read"]

Pinned headers: {"X-Version": "2026-11-05"}

Official provider source

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.