Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/customers \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "platformCustomerId": "9f84e0c2a72c4fa",
      "customerType": "INDIVIDUAL",
      "kycStatus": "APPROVED",
      "umaAddress": "$john.doe@uma.domain.com",
      "createdAt": "2025-07-21T17:32:28Z",
      "updatedAt": "2025-07-21T17:32:28Z",
      "isDeleted": false,
      "fullName": "John Michael Doe",
      "birthDate": "1990-01-15",
      "nationality": "US",
      "address": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
platformCustomerId
string

Filter by platform-specific customer identifier

​
customerType
enum<string>

Filter by customer type

Available options:
INDIVIDUAL,
BUSINESS
Example:

"INDIVIDUAL"

​
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)

​
umaAddress
string

Filter by uma address

​
isIncludingDeleted
boolean

Whether to include deleted customers in the results. Default is false.

Response

Successful operation

​
data
(Individual Customer · object | Business Customer · object)[]
required

List of customers matching the filter criteria

  • Individual Customer
  • Business Customer
​
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 customers matching the criteria (excluding pagination)

⌘I