v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
tokens

aid_customers_cid_tokens_get

Get all tokens for a Customer scopes:

  • admin:customers
  • read:customers
  • user:customers
get/accounts/{aid}/customers/users/{customer_id}/tokens

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

customer_idstring required

The customer id you have defined for the customer. (must not have trailing or leading spaces)

Query parameters

typestring

filter tokens on type

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

starting_afterstring

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, end the result contains paging_token=pt1, your subsequent call can include starting_after=pt1 in order to fetch the next page of the list.

totalboolean

include total-count header in the response

include_deletedboolean

include deleted tokens in the response.

Response

Token collection

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

updated_atstring date-time

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time
token_idstring

The token id you have defined for the token. (must not have trailing or leading spaces)

typestring required

identifies how or who is resposible for the token value

valuestring required
metadataobject

Additional metadata about the token or the entity the token was created from

Example response

[
  {
    "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "type": "sha1:email",
    "value": "a1b79ef1a62d94ffa86b3f3d846df0ee3993af92",
    "metadata": {
      "exp_month": 10,
      "exp_year": 20,
      "mask_pan": "**** **** **** 3477"
    }
  }
]