Sign in
Customers

Get all customers

get/v1/customers

Query parameters

limitnumber

Number of results to return (1-1000). Use with offset for traditional pagination.

offsetnumber

Number of results to skip. Use with limit for traditional pagination.

page_sizenumber

Number of results per page (1-1000). Use with starting_after for cursor-based pagination.

starting_afterstring

Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.

status'DRAFT' | 'IN_REVIEW' | 'NEED_ACTIONS' | 'REJECTED' | 'ACTIVE' | 'INACTIVE' | 'SUSPENDED'

Filter by customer status

type'INDIVIDUAL' | 'BUSINESS'

Filter by customer type

searchstring

Search by customer name or email

organizationIdstring

Filter by organization ID. Must be within the caller accessible org scope.

Headers

X-API-Keystring

API key

Response

Paginated list of customers

totalnumber
limitnumber
offsetnumber

Changes

Changed in 7 of the 19 revisions of this API.45

  • c5a90949ca591See the full diff
    • ○

      added the required property /////////// to the response with the status

      response-required-property-added

  • bb2702829ce01See the full diff
    • ●

      added the new ROBINHOOD enum value to the //////////// response property for the response status

      response-property-enum-value-added

  • 916d2367a8f81See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 7788dddbcb212See the full diff
    • ○

      added the optional property ///////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

  • 16bbb87acca91See the full diff
    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

  • 70223aefae8c1See the full diff
    • ●

      added the new LIVENESS_CHECK enum value to the //// response property for the response status

      response-property-enum-value-added

  • 7d6487f295d72See the full diff
    • ●

      added the new MESTA enum value to the /////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new MESTA enum value to the ///////// response property for the response status

      response-property-enum-value-added