Skip to main content
GET
/
businesses
/
{id}
/
customers
List all customers for a business
curl --request GET \
  --url https://api.pocketflows.com/businesses/{id}/customers \
  --header 'Authorization: Basic <encoded-value>'
{
  "customers": [
    {
      "id": "<string>",
      "external_id": "<string>",
      "email_address": "<string>",
      "phone_number": "<string>",
      "metadata": {},
      "unsubscribed": "future"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the business

Query Parameters

​
email_address
string

The email address to filter on

​
phone_number
string

The phone number to filter on

Response

200 - application/json

A dictionary with a customers property which is an array of Customer objects

​
customers
The Customer object · object[]
required

An array of customers