List Customers

GET /customers

cURL

cURL

curl --request GET \
  --url https://api-dev.withflock.com/customers \
  --header 'Authorization: <api-key>'

200

{
  "total": 123,
  "limit": 123,
  "offset": 123,
  "data": [
    {
      "id": "<string>",
      "externalUserId": "<string>",
      "email": "<string>",
      "name": "<string>",
      "referredBy": {
        "id": "<string>",
        "externalUserId": "<string>",
        "email": "<string>",
        "name": "<string>"
      },
      "referredById": {},
      "referredByReferralId": "<string>",
      "referredInCampaignId": "<string>",
      "visitedReferralsCount": 123,
      "convertedReferralsCount": 123,
      "referralCode": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "organizationId": "<string>",
      "applicationId": "<string>",
      "customProperties": {},
      "environment": "production"
    }
  ]
}

Authorizations

Authorization · string · header · required

Query Parameters

limit · number · required

offset · number · required

externalUserId · string · required

Response

200 - application/json

total · number · required

limit · number · required

offset · number · required

data · object[] · required

Show child attributes