Skip to main content
GET
/
v1
/
customers
List Customers
curl --request GET \
  --url https://api.monk.com/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "legalName": "<string>",
      "tags": [
        "<string>"
      ],
      "isPaused": true,
      "pausedAt": "<string>",
      "metadata": {
        "externalCustomerId": "<string>",
        "externalCompanyIds": [
          "<string>"
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.monk.com/llms.txt

Use this file to discover all available pages before exploring further.

Use externalCustomerId to look up a customer by your external identifier. Scope: customers:read

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
externalCustomerId
string

Filter by external customer ID (exact match)

​
limit
integer
default:10
Required range: x <= 100
​
offset
integer
default:0

Response

Paginated customer list

​
data
object[]
​
hasMore
boolean
​
total
integer