Skip to main content
GET
List platform customers
List every exporter entity under your platform account. Use this to reconcile your records with the API, or to look up a platformCustomerId you did not store. The roster is scoped to the mode your key selects: a dev_ key lists test clients only, a prod_ key lists live clients only. Results are ordered newest first.

Request example

page starts at 1 and defaults to 1. limit defaults to 10 and caps at 100. search filters by partial name or email, case insensitive, and must be at least 1 character.

Response example

See the client object for what each field means. Two things differ on this endpoint:
  • updatedAt and mode are not returned in the list. Use Get Customer by Id for updatedAt.
  • Fields the client has no value for are null here, not absent.
isActive: false with hasDgftCredentials: false means onboarding was never finished. That client cannot file until you validate its DGFT credentials.

Errors

  • 400 Validation failed for an out-of-range limit, a page below 1, or an empty search.
  • 401 No API key provided or Invalid API key. See authentication errors.
  • 403 Only platform users can access this resource, or Master Platform Agreement not signed yet.

Next steps

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer<int32>
default:1

Page number (starts at 1)

Required range: x >= 1
limit
integer<int32>
default:10

Items per page

Required range: 1 <= x <= 100

Filter by partial name or email

Response

Paginated list of platform customers

items
object[]
meta
object