Skip to main content
GET
/
contacts
List contacts
curl --request GET \
  --url https://api.privy.com/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cus_a1b2c3d4e5f6g7h8",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@example.com",
      "email_permission": "subscribed",
      "phone_number": "+15551234567",
      "phone_permission": "subscribed",
      "tags": [
        "vip"
      ],
      "custom_fields": {
        "loyalty_tier": "gold"
      },
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-03-20T14:22:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6
  }
}

Documentation Index

Fetch the complete documentation index at: https://help.privy.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

Send either an API token or an OAuth access token as Authorization: Bearer <token>. See the Authentication page for details.

Query Parameters

​
page
integer
default:1

Page number (starts at 1).

Required range: x >= 1
​
per_page
integer
default:25

Number of results per page.

Required range: 1 <= x <= 100
​
email
string<email>

Filter by exact email address.

​
phone_number
string

Filter by exact phone number (E.164 format).

​
email_permission
enum<string>

Filter by email consent status.

Available options:
subscribed,
unsubscribed,
non_subscribed
​
phone_permission
enum<string>

Filter by SMS consent status.

Available options:
subscribed,
unsubscribed,
non_subscribed

Response

A paginated list of contacts.

​
data
object[]
​
pagination
object