LIlightsparkdev
API Tokens

Create a new API token

Changed on

Create a new API token to access the Grid APIs.

post/tokens

Request

  • Base URL
    https://api.lightspark.com/grid/2025-10-13
  • URL
    https://api.lightspark.com/grid/2025-10-13/tokens
  • Auth
    HTTP basic

Request body

namestring required

Name of the token to help identify it

permissionsPermission[] required

A list of permissions to grant to the token

Example request

{
  "name": "Sandbox read-only"
}

Response

API token created successfully

idstring required

System-generated unique identifier

namestring required

Name of the token

permissionsPermission[] required

A list of permissions granted to the token

clientIdstring 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.

clientSecretstring

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.

expiresAtstring date-time

Timestamp after which the token no longer authenticates. Requests made with an expired token return 401. Omitted when the token does not expire.

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

{
  "id": "Token:019542f5-b3e7-1d02-0000-000000000001",
  "name": "Sandbox read-only token",
  "clientId": "01947d2284054f890000e63bca4810df",
  "clientSecret": "ed0ad25881e234cc28fb2dec0a4fe64e4172",
  "expiresAt": "2026-07-21T17:32:28Z",
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z"
}

Changes

  • d996ddfb9d2bRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 715332dcb111Revision changes
    • warning

      added the new EXACT_AMOUNT_UNAVAILABLE enum value to the response property for the response status