Skip to main content
GET
/
customers
/
{id}
Retrieve a customer
curl --request GET \
  --url https://api.pocketflows.com/customers/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "external_id": "<string>",
  "email_address": "<string>",
  "phone_number": "<string>",
  "full_name": "<string>",
  "metadata": {}
}

Documentation Index

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

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

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 customer

Response

200 - application/json

A Customer object

​
id
string
required

The ID of the customer

​
external_id
string | null
required

The external ID of the customer

​
email_address
string | null
required

The email address of the customer

​
phone_number
string | null
required

The phone number of the customer

​
full_name
string | null
required

The full name of the customer

​
metadata
object
required

The metadata associated with this customer

​
unsubscribed
enum<string> | null
required

The unsubscribe status of the customer

Available options:
future,
campaign