List tokens - Lightspark Docs

List tokens

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.lightspark.com/grid/2025-10-13/tokens', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.lightspark.com/grid/2025-10-13/tokens")
  .get()
  .addHeader("Authorization", "Basic <encoded-value>")
  .build()

val response = client.newCall(request).execute()

{
  "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",
      "expiresAt": "2026-07-21T17:32:28Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

{
  "code": "INVALID_INPUT",
  "reason": "<string>",
  "details": {
    "errors": [
      {
        "field": "identifier",
        "constraint": {
          "format": "email",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "enum": [
            "SSN",
            "ITIN",
            "NON_US_TAX_ID"
          ],
          "minLength": 1,
          "maxLength": 500
        },
        "message": "Value is not one of the allowed enum members."
      }
    ],
    "missingRequirements": [
      "SUPPORTING_PROOF"
    ],
    "refusalReason": "AGENT_POLICY_DENIED",
    "missingFields": [
      "PHONE_NUMBER"
    ]
  }
}

{
  "code": "UNAUTHORIZED",
  "reason": "<string>",
  "details": {}
}

{
  "code": "GRID_SWITCH_ERROR",
  "reason": "<string>",
  "details": {}
}

GET

/

tokens

List tokens

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.lightspark.com/grid/2025-10-13/tokens', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.lightspark.com/grid/2025-10-13/tokens")
  .get()
  .addHeader("Authorization", "Basic <encoded-value>")
  .build()

val response = client.newCall(request).execute()

{
  "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",
      "expiresAt": "2026-07-21T17:32:28Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

{
  "code": "INVALID_INPUT",
  "reason": "<string>",
  "details": {
    "errors": [
      {
        "field": "identifier",
        "constraint": {
          "format": "email",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "enum": [
            "SSN",
            "ITIN",
            "NON_US_TAX_ID"
          ],
          "minLength": 1,
          "maxLength": 500
        },
        "message": "Value is not one of the allowed enum members."
      }
    ],
    "missingRequirements": [
      "SUPPORTING_PROOF"
    ],
    "refusalReason": "AGENT_POLICY_DENIED",
    "missingFields": [
      "PHONE_NUMBER"
    ]
  }
}

{
  "code": "UNAUTHORIZED",
  "reason": "<string>",
  "details": {}
}

{
  "code": "GRID_SWITCH_ERROR",
  "reason": "<string>",
  "details": {}
}

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

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)