ALalternativepayments
Customers

List customers

Changed on

Get a paginated list of customers with optional filtering

get/customers

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/customers
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: customers:read

Query parameters

limitinteger

Number of items to return

afterstring

Specifies the cursor after which to start returning results. For the first page, this should be left empty. For subsequent pages, use the value of the end_cursor field from the previous response.

beforestring

Specifies the cursor before which to return results. Use this to paginate backwards. For example, to load the previous page, provide the value of the start_cursor field from the last response.

created_at_startstring

Filter by creation date start (RFC3339 format)

created_at_endstring

Filter by creation date end (RFC3339 format)

company_namestring

Filter by customer name

tag_idsstring

Comma-separated tag IDs (repeated tag_ids keys are also accepted), at most 100 distinct; returns customers that have any of these tags

Response

OK

end_cursorstring
has_next_pageboolean
has_previous_pageboolean
start_cursorstring

Example response

{
  "data": [
    {
      "tag_ids": [
        "0b8f3c5e-6d2a-4f1b-9a7e-3c4d5e6f7a8b"
      ]
    }
  ],
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}

Changes

  • 7b8246f9fc1cRevision changes
    • info

      added the new optional query request parameter tag_ids

    • info

      added the non-success response with the status

    • info

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