> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.partnerpage.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.partnerpage.io/_mcp/server.

# Quickstart

The PartnerPage API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). It has predictable resource-oriented URLs, accepts JSON, form-encoded and multipart request bodies, returns JSON responses, and uses standard HTTP response codes, authentication and verbs.

#### Create an API key

In the PartnerPage dashboard, open [Settings → Developers](https://directory.partnerpage.io/developers) and create a key. If you only need to read, create a read-only key. See [Authentication](/get-started/authentication).

#### List your directories

Send the key in the `Authorization` header:

```bash
curl https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/ \
  -H "Authorization: Token <your API key>"
```

The response lists your organization's directories. Each one's `id` is the directory UUID the other endpoints ask for.

#### Explore the API

Browse the [API reference](/api-reference/directory/list-directories), or show your partners on your website with [Build your own directory site](/guides/build-your-own-directory-site).

Requests act on your production data. The PartnerPage API does not have a test mode.

Most endpoints work on one object per request. Partner entries can also be created or updated in bulk, with [Bulk upsert partner entries](/api-reference/entry/partner-entry/bulk-upsert-partner-entries).

> **Info**
>
> The PartnerPage API is available on some of our [pricing plans](https://www.partnerpage.io/pricing). To get access, email [support@partnerpage.io](mailto:support@partnerpage.io) about upgrading your plan.