Settings > Developers is where you turn on the PartnerPage API for your organization, copy your Organization ID and create API keys, called access tokens. Developers then use the key with the API reference at https://docs.partnerpage.io. Vendors and partners each have this page for their own organization.
Who can do this: Admin role · Availability: all organizations
Turn on API access
To turn on the PartnerPage API for your organization:
In the dashboard menu, under Settings, click Developers.
On the API access card, switch the toggle on.
Click Save.
The card says "API access is enabled for your organization." and the Access tokens card appears.
Create an API key (access token)
To create a PartnerPage API key:
In Settings > Developers, on the Access tokens card, click Add access token.
Enter a Name of up to 30 characters, such as "CRM sync".
Under Access, choose Full access or Read-only.
Click Save.
Click Copy token and store the key somewhere safe, such as your server's secret store.
An organization can have one Full access key and one Read-only key at a time. The card shows how many you have, such as 2/2.
The following table compares the two kinds of key.
Key | What it can do | Use it for |
Full access | Reads and changes your directory through the API | Integrations that create or update partners, close contact requests or manage webhooks |
Read-only | Reads everything a full-access key can, including contact requests, but can't change anything | Reporting, dashboards and syncs that only read |
Use your API key
Send the key in the Authorization header of each request, as Authorization: Token <your key>, and use your Organization ID where the API reference asks for it. The Organization ID card on Settings > Developers has a copy button. Endpoints, fields and examples are in the API reference at https://docs.partnerpage.io.
API rate limits
Each PartnerPage API key can make 1,000 requests per hour to each endpoint. A few endpoints allow fewer, such as 50 per hour for creating contact requests from your own systems. Over the limit, the API answers with HTTP 429 and "Rate limit exceeded. Please wait and try again."
Why a read-only key gets a 403 error
A Read-only key can't change anything. Any request that creates, updates or deletes data returns HTTP 403 with "This API key is read-only and can't make changes". A read-only key also can't read API keys, webhook settings, signing secrets or delivery logs: those return HTTP 403 with "This API key is read-only and can't use this endpoint". Use the Full access key for those requests.
Delete or replace an API key
To delete a PartnerPage API key, click the remove button next to it on the Access tokens card and confirm. Every request that uses the key fails from then on, and deleting can't be undone. To replace a key, delete it and add another key of the same type, then update your integration.
To stop a key from working, delete it. Switching API access off doesn't stop keys that already exist, and it hides the Access tokens card, so delete your keys before you switch API access off.
The API Key card on your Profile page
A small number of older accounts also see an API Key card on their Profile page. That personal key belongs to an older integration and is not the key for the PartnerPage API. Use the keys on Settings > Developers for the API.
For partners
Partner organizations have the same Developers page, so a partner's Admin can turn on API access and create keys for their own organization. The partner's page also holds the Lead webhook, which sends each contact request on the partner's profiles to their own tools. See Send new leads to your own tools with a webhook.