Skip to content

Search customers

GET
/api/customers
curl --request GET \
--url https://example.com/api/customers \
--cookie better-auth.session_token=<better-auth.session_token>

Customers matching the query.

Media type application/json
object
customers
required
Array<object>

A customer available for offer assignment.

object
id
required
string
name
required
string
source
required
string
Example generated
{
"customers": [
{
"id": "example",
"name": "example",
"source": "example"
}
]
}

No valid Better Auth session was present.

Media type application/json

Returned when no valid Better Auth session is present.

object
error
required
string
Example generated
{
"error": "example"
}