List tokens

List tokens

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/tokens \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "id": "Token:019542f5-b3e7-1d02-0000-000000000001",
      "name": "Sandbox read-only token",
      "permissions": [
        "VIEW"
      ],
      "clientId": "01947d2284054f890000e63bca4810df",
      "createdAt": "2025-07-21T17:32:28Z",
      "updatedAt": "2025-07-21T17:32:28Z",
      "clientSecret": "ed0ad25881e234cc28fb2dec0a4fe64e4172"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

GET

tokens

List tokens

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/tokens \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "id": "Token:019542f5-b3e7-1d02-0000-000000000001",
      "name": "Sandbox read-only token",
      "permissions": [
        "VIEW"
      ],
      "clientId": "01947d2284054f890000e63bca4810df",
      "createdAt": "2025-07-21T17:32:28Z",
      "updatedAt": "2025-07-21T17:32:28Z",
      "clientSecret": "ed0ad25881e234cc28fb2dec0a4fe64e4172"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

Authorization

string

header

required

API token authentication using format <api token id>:<api client secret>

Query Parameters

name

string

Filter by name of the token

createdAfter

string<date-time>

Filter customers created after this timestamp (inclusive)

createdBefore

string<date-time>

Filter customers created before this timestamp (inclusive)

updatedAfter

string<date-time>

Filter customers updated after this timestamp (inclusive)

updatedBefore

string<date-time>

Filter customers updated before this timestamp (inclusive)

limit

integer

default:20

Maximum number of results to return (default 20, max 100)

Required range: 1 <= x <= 100

cursor

string

Cursor for pagination (returned from previous request)

Response

Successful operation

data

object[]

required

List of tokens matching the filter criteria

Show child attributes

data.id

string

required

System-generated unique identifier

Example:

"Token:019542f5-b3e7-1d02-0000-000000000001"

data.name

string

required

Name of the token

Example:

"Sandbox read-only token"

data.permissions

enum<string>[]

required

A list of permissions granted to the token

Permission of an API token that determines what actions the token can perform: VIEW: Can view all data, including platform config, customers and transactions TRANSACT: Can send payments MANAGE: Can manage platform config, api tokens and customers

Available options:

VIEW,

TRANSACT,

MANAGE

data.clientId

string

required

An opaque identifier that should be used as a client_id (or username) in the HTTP Basic Authentication scheme when issuing http requests to Grid.

Example:

"01947d2284054f890000e63bca4810df"

data.createdAt

string<date-time>

required

Creation timestamp

Example:

"2025-07-21T17:32:28Z"

data.updatedAt

string<date-time>

required

Last update timestamp

Example:

"2025-07-21T17:32:28Z"

data.clientSecret

string

The secret that should be used to authenticate against Grid API. This secret is not stored and will never be available again after creation. Platform must keep this secret secure as it grants access to the account.

Example:

"ed0ad25881e234cc28fb2dec0a4fe64e4172"

hasMore

boolean

required

Indicates if more results are available beyond this page

nextCursor

string

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCount

integer

Total number of tokens matching the criteria (excluding pagination)

This endpoint provides a list of Counterparty Providers that are available.Create a new API token

⌘I

Using the API

API documentation

Authorizations

Query Parameters

Response