List customers

List customers

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

{
  "data": [
    {
      "platformCustomerId": "9f84e0c2a72c4fa",
      "customerType": "INDIVIDUAL",
      "umaAddress": "[email protected]",
      "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "kycStatus": "APPROVED",
      "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",
        "postalCode": "94105",
        "country": "US",
        "line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

GET

customers

List customers

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

{
  "data": [
    {
      "platformCustomerId": "9f84e0c2a72c4fa",
      "customerType": "INDIVIDUAL",
      "umaAddress": "[email protected]",
      "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "kycStatus": "APPROVED",
      "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",
        "postalCode": "94105",
        "country": "US",
        "line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA"
      }
    }
  ],
  "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 Whether the customer is an individual or a business entity

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

Show child attributes

data.platformCustomerId

string

required

Platform-specific customer identifier

Example:

"9f84e0c2a72c4fa"

data.customerType

enum<string>

required

Whether the customer is an individual or a business entity

Available options:

INDIVIDUAL,

BUSINESS

Example:

"INDIVIDUAL"

data.umaAddress

string

required

Full UMA address (always present in responses, even if system-generated). This is an optional identifier to route payments to the customer.

Example:

"[email protected]"

data.id

string

System-generated unique identifier

Example:

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

data.kycStatus

enum<string>

The current KYC status of a customer

Available options:

APPROVED,

REJECTED,

PENDING_REVIEW,

EXPIRED,

CANCELED,

MANUALLY_APPROVED,

MANUALLY_REJECTED

Example:

"APPROVED"

data.createdAt

string<date-time>

Creation timestamp

Example:

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

data.updatedAt

string<date-time>

Last update timestamp

Example:

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

data.isDeleted

boolean

Whether the customer is marked as deleted

Example:

false

data.fullName

string

Individual's full name

Example:

"John Michael Doe"

data.birthDate

string<date>

Date of birth in ISO 8601 format (YYYY-MM-DD)

Example:

"1990-01-15"

data.nationality

string

Country code (ISO 3166-1 alpha-2)

Example:

"US"

data.address

object

Show child attributes

data.address.line1

string

required

Street address line 1

Example:

"123 Main Street"

data.address.postalCode

string

required

Postal/ZIP code

Example:

"94105"

data.address.country

string

required

Country code (ISO 3166-1 alpha-2)

Example:

"US"

data.address.line2

string

Street address line 2

Example:

"Apt 4B"

data.address.city

string

City

Example:

"San Francisco"

data.address.state

string

State/Province/Region

Example:

"CA"

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)

Update platform configuration Add a new customer

⌘I

Using the API

API documentation

Authorizations

Query Parameters

Response