API Overview

Please note API access is only available to paid accounts. If requests fail despite valid credentials, confirm with Support that API access is available for your account. Use Privy’s API to connect your own tools, scripts, or agents to your Privy account. With the API, you can:

Create contacts
Update contact or consent properties
Send order events to trigger Flows and populate order data in your Privy account
Send custom events to trigger Flows from activity in your own systems

Base URL

All API requests use the following base URL:

https://api.privy.com/v1

Quick start

Get a token

The fastest way to get started is to create an API token from Settings > API Tokens in your Privy dashboard. See API Tokens for details.Alternatively, create an OAuth application under Settings > API > API Tokens to use the OAuth client credentials flow.

Make your first request

Use your bearer token to list your contacts:

curl -X GET "https://api.privy.com/v1/contacts" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Check the response

You’ll receive a JSON response with your contact data and pagination info:

{
  "data": [
    {
      "id": "cus_a1b2c3d4e5f6g7h8",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@example.com",
      "email_consent": "subscribed",
      "phone_number": "+15551234567",
      "sms_consent": "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
  }
}

Next steps

API Tokens

Generate a token and start making requests in minutes.

Authentication

Set up OAuth credentials and learn about scopes.

Rate Limits

Understand request limits and how to handle them.

Errors

Learn about error codes and response format.

Authentication

⌘I

API Reference

Contacts

Orders

Events

Base URL

Quick start

Next steps

API Tokens

Authentication

Rate Limits

Errors

​Base URL

​Quick start

​Next steps

API Tokens

Authentication

Rate Limits

Errors

Base URL

Quick start

Next steps