Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://rest.staging.nickel.com/customers \
  --header 'Authorization: Bearer <token>'
{
  "customers": [
    {
      "id": "clkqzo2y1000cx9tfohoiodq1",
      "name": "Claudio Wilson",
      "emails": [
        "<string>"
      ],
      "achEnabled": false,
      "feePassthroughPercent": 100
    }
  ],
  "totalResults": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

1-indexed page number for pagination.

Required range: x >= 1
Example:

1

​
pageSize
integer

Number of results per page.

Required range: x >= 1
Example:

25

​
name
string

Case-insensitive substring filter applied to the customer's name.

Example:

"claudio"

​
email
string

Case-insensitive substring filter applied to any of the customer's email addresses.

Example:

"example.com"

Response

Successful operation

​
customers
object[]

The page of customer records that match the supplied filters.

​
totalResults
integer

Total number of customers matching the filters across all pages.