Customers

List customers

One page of the org's customers, newest first. Filter with customer_type, status or pending_rfi, and page with cursor. next_cursor is null on the last page; a filtered page is still a full page, so an empty customers array together with a null next_cursor is the only end-of-list signal.

get/v0/customers

Request

  • Base URL
    https://orchestration.seismic.systems/api
  • Auth
    API key in header Api-Key

Query parameters

customer_type'individual' | 'business'

Only individuals, or only businesses. Omit for both.

status'draft' | 'submitted' | 'under_review' | 'action_required' | 'approved' | 'rejected' | 'terminally_rejected' | 'paused' | 'unknown'

Only customers whose rolled-up verification status is this one.

pending_rfiboolean

true for customers with an open request for information, false for those without.

cursorstring

next_cursor from the previous page. Omit on the first request.

limitinteger

Page size. Defaults to 50, capped at 200.

Response

One page of customers, newest first.

next_cursorstring nullable

Pass back as ?cursor= for the next page. null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.