Skip to main content
GET
/
customers
List all customers
curl --request GET \
  --url https://api.flatpeak.com/customers \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": "/customers",
  "has_more": true,
  "data": [
    {
      "id": "cus_65e421d1daa4a24082b4f590",
      "object": "customer",
      "live_mode": true,
      "time_created": "2021-05-05T05:37:27Z",
      "account_id": "acc_65e421bed29d88d9012e0662",
      "reference_id": "CUS1234567890",
      "locations": [
        "loc_641b90b758fb8e6293716e40"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Query Parameters

​
ending_before
string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the previous page in the list, include ending_before, which is the first ID in the currently retrieved list.

​
limit
integer

A limit on the number of objects to be returned. Can range between 1 and 100, and the default is 30.

​
starting_after
string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the next page in the list include starting_after where ID is the last ID in the currently retrieved list.

​
reference_id
string

A reference that is meaningful to you, for example, an ID from your system.

Response

​
object
string

Represents the object’s type. i.e. list.

Example:

"list"

​
url
string

Represents the URL slug for the object.

Example:

"/customers"

​
has_more
boolean

Is set to true if more objects are available.

​
data
Customer · object[]