Show examples in:
Javascript HTTP
Content Management API > API token

API token

An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.

Object payload

id string

ID of access_token

Example: "312"
type string

Must be exactly "access_token".

attributes.name string

Name of API token

Example: "Read-only API token"
attributes.hardcoded_type null, string
attributes.can_access_cda boolean

Whether this API token can access the Content Delivery API published content endpoint

attributes.can_access_cda_preview boolean

Whether this API token can access the Content Delivery API draft content endpoint

attributes.can_access_cma boolean

Whether this API token can access the Content Management API

attributes.last_cma_access enum

When this API token was last used to access the Content Management API

Example: "never"
today

Today

yesterday

Yesterday

this_week

This week (Monday-Sunday)

last_week

Last week (Monday-Sunday)

this_month

This calendar month

last_month

Last calendar month

never

No recent usage (beyond last month)

attributes.last_cda_access enum

When this API token was last used to access the Content Delivery API

Example: "never"
today

Today

yesterday

Yesterday

this_week

This week (Monday-Sunday)

last_week

Last week (Monday-Sunday)

this_month

This calendar month

last_month

Last calendar month

never

No recent usage (beyond last month)

attributes.token null, string

The actual API token (or null if the current user has no permission to read the token)

Example: "XXXXXXXXXXXXXXX"
relationships.role.data

Role

Available endpoints