List client-side tokens

Permission required

gethttps://api.paddle.com/client-tokens

Returns a paginated list of client-side tokens. Use the query parameters to page through results.

Query Parameters

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

statusarray[string]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

Response

dataarray[object]

Represents a client-side token entity.

idstring

Unique Paddle ID for this client-side token entity, prefixed with ctkn_. Not used for Paddle.js authentication; use token for authentication.

tokenstring

A client-side token, prefixed with test or live depending on the environment of your account. Pass as the token parameter when initializing Paddle.js to authenticate.

namestring

Short name of this client-side token. Typically unique and human-identifiable.

descriptionstring or null

Short description of this client-side token. Typically gives details about what the token is used for and where it's used.

statusstring

Status of this client-side token.

revoked_atstring<date-time> or null

RFC 3339 datetime string of when this client-side token was revoked. null if not revoked.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

paginationobject

Keys used for working with paginated results.

Response