Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.fernhq.com/customers \
  --header 'Authorization: Bearer <token>'
{
  "customers": [
    {
      "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
      "customerStatus": "ACTIVE",
      "customerType": "INDIVIDUAL",
      "name": "John Doe",
      "email": "johndoe@example.com",
      "kycLink": "https://app.fernhq.com/verify-customer/03b7030f-6da1-4d76-9352-cdebd82112c8",
      "verificationLink": "https://app.fernhq.com/verify-customer/03b7030f-6da1-4d76-9352-cdebd82112c8",
      "updatedAt": "2023-10-01T12:00:00Z",
      "organizationId": "8469411c-48c1-4e26-a032-44688be9cb4b"
    }
  ],
  "nextPageToken": "xyz"
}

Authorizations

​
Authorization
string
header
required

To authenticate server-side requests

Query Parameters

​
pageToken
string

Token for forward pagination

​
pageSize
integer
default:10

Number of items per page (default: 10, max: 100)

Required range: x >= 1
​
organizationId
string<uuid>

Organization ID to filter customers

Response

Default Response

​
customers
Get Customer Response · object[]

Retrieved customers

​
nextPageToken
string

Page token to use to fetch next page

Example:

"xyz"