> ## Documentation Index
> Fetch the complete documentation index at: https://developers.conveyour.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ConveYour for Developers

> REST APIs, webhooks, and Liquid templating for automating onboarding, compliance, and field-team workflows.

Automate onboarding, compliance, and messaging for field teams. **217 endpoints across 28 resources**, one auth header, one response envelope.

## Make your first call

Create a key in **Settings → API**, then:

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://<your-subdomain>.conveyour.com/api/contacts?limit=5" \
    -H "x-conveyour-token: YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const res = await fetch(
    "https://<your-subdomain>.conveyour.com/api/contacts?limit=5",
    { headers: { "x-conveyour-token": process.env.CONVEYOUR_TOKEN } },
  );
  const body = await res.json();
  if (body.status === "ok") console.log(body.data.results);
  ```

  ```python Python theme={null}
  import requests

  r = requests.get(
      "https://<your-subdomain>.conveyour.com/api/contacts",
      headers={"x-conveyour-token": TOKEN},
      params={"limit": 5},
  )
  body = r.json()
  if body["status"] == "ok":
      print(body["data"]["results"])
  ```
</CodeGroup>

<Warning>
  **Check `status`, not the HTTP code.** Around a third of endpoints return HTTP `200` with `"status": "failed"` in the body, so `if (response.ok)` will treat failures as successes.
</Warning>

## Start here

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/quickstart">
    Create a service account and API key, and understand which permissions each key really needs.
  </Card>

  <Card title="API Conventions" icon="list-check" href="/guides/api-conventions">
    The rules every endpoint shares — envelope, errors, team scoping, pagination, CSV export, and ID types.
  </Card>

  <Card title="Contacts API" icon="address-book" href="/api-reference/contacts/list-contacts">
    The most-used resource: list, create, merge, archive, and enrich contacts.
  </Card>

  <Card title="Liquid Syntax" icon="code" href="/guides/liquid-syntax">
    Personalize SMS, email, and lessons — filters, snippets, and custom object queries.
  </Card>
</CardGroup>

## Build an integration

<CardGroup cols={3}>
  <Card title="Analytics" icon="chart-line" href="/api-reference/analytics/identify-a-contact">
    Identify contacts and track events from the browser with a client-safe key.
  </Card>

  <Card title="Webhooks" icon="plug" href="/guides/webhook-response-operations">
    Receive events, and write contact fields back from your endpoint's response.
  </Card>

  <Card title="Integrations" icon="puzzle-piece" href="/integrations/integrations">
    Zapier, SignWell, Okta, Cal.com, JotForm, and more.
  </Card>
</CardGroup>

## Good to know

<AccordionGroup>
  <Accordion title="Not every endpoint works with an API key" icon="triangle-exclamation">
    26 endpoints always return `403` for any API key, no matter how the service account is configured — all of Compliance, Roles and Senders, plus Teams writes, Org billing, and Webhook credentials. Service accounts cannot be granted admin, so these need a signed-in user. See [Authentication](/quickstart).
  </Accordion>

  <Accordion title="Pagination is not uniform" icon="layer-group">
    Only 8 list endpoints return a paginated envelope; 29 ignore `page` entirely and return a flat array. Check the endpoint's page before assuming `page` works — see [Pagination](/guides/api-conventions#pagination).
  </Accordion>

  <Accordion title="IDs are not all the same type" icon="fingerprint">
    Most resources use an internal ID: a 24-character hex string. Links, Notes and Fields use integers, and Reports use string keys. Type your client's ID fields accordingly.
  </Accordion>
</AccordionGroup>

<Tip>
  Need help? Email [support@conveyour.com](mailto:support@conveyour.com) or visit the [Help Center](https://conveyour.com/help).
</Tip>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.