Customers

List customers

Lists the customers on your seller account, in ascending customer ID order.

post/v1/seller/customers/list

Request

  • Base URL: https://api.anrok.com
  • URL: https://api.anrok.com/v1/seller/customers/list
  • Auth: HTTP bearer

Request body

limitinteger

The maximum number of customers to return.

cursorstring

The cursor to use for pagination. This is the value of the nextCursor field returned from the previous page.

Example request

{
  "cursor": "eyJleGFtcGxlIjoidGhpcyBpcyBhbiBleGFtcGxlIGN1cnNvciJ9"
}

Response

OK

nextCursorstring nullable required

The cursor to use to fetch the next page of results. Null if there are no more pages.

hasMoreboolean required

Whether there are more customers available beyond this page.

Example response

{
  "customers": [
    {
      "id": "cus_K39sWBu92Lo",
      "name": "Acme Inc",
      "emailAddress": "john.doe@example.com"
    }
  ],
  "nextCursor": "eyJleGFtcGxlIjoidGhpcyBpcyBhbiBleGFtcGxlIGN1cnNvciJ9"
}

Changes

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