Skip to navigation
Get started

Quickstart

Make your first request to the PartnerPage API.
View as Markdown

The PartnerPage API is organized around REST. 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.

1

Create an API key

In the PartnerPage dashboard, open Settings → Developers and create a key. If you only need to read, create a read-only key. See Authentication.

2

List your directories

Send the key in the Authorization header:

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.

3

Explore the API

Browse the API reference, or show your partners on your website with 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.

The PartnerPage API is available on some of our pricing plans. To get access, email support@partnerpage.io about upgrading your plan.