> ## 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.

# API Overview

> Use Privy's API to connect your own tools, scripts, or agents to your Privy account.

Please note API access is only available to paid accounts. If requests fail despite valid credentials, confirm with [Support](mailto:support@privy.com) 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](/docs/api-reference/create-contact)
* [Update contact or consent properties](https://help.privy.com/docs/api-reference/update-contact)
* **[Send order events](/docs/api-reference/order-placed)** to trigger Flows and populate order data in your Privy account

## Base URL

All API requests use the following base URL:

```text theme={null}
https://api.privy.com/v1
```

## Quick start

<Steps>
  <Step title="Get a token">
    The fastest way to get started is to create an **API token** from **Settings > API Tokens** in your [Privy dashboard](https://dashboard.privy.com). See [API Tokens](/docs/api-reference/api-tokens) for details.

    Alternatively, create an OAuth application under **Settings > Apps** to use the [OAuth client credentials flow](/docs/api-reference/authentication).
  </Step>

  <Step title="Make your first request">
    Use your bearer token to list your contacts:

    ```bash theme={null}
    curl -X GET "https://api.privy.com/v1/contacts" \
      -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
    ```
  </Step>

  <Step title="Check the response">
    You'll receive a JSON response with your contact data and pagination info:

    ```json theme={null}
    {
      "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
      }
    }
    ```
  </Step>
</Steps>

## Next steps

<CardGroup cols={2}>
  <Card title="API Tokens" icon="key" href="/docs/api-reference/api-tokens">
    Generate a token and start making requests in minutes.
  </Card>

  <Card title="Authentication" icon="lock" href="/docs/api-reference/authentication">
    Set up OAuth credentials and learn about scopes.
  </Card>

  <Card title="Rate Limits" icon="gauge" href="/docs/api-reference/rate-limits">
    Understand request limits and how to handle them.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/docs/api-reference/errors">
    Learn about error codes and response format.
  </Card>
</CardGroup>