Authentication
Send an API key with your requests, and choose between full-access and read-only keys.
Requests to the PartnerPage API carry an API key in the Authorization header:
Create and copy your keys in the PartnerPage dashboard under Settings → Developers. Endpoints that need a key refuse requests without a valid one. The public reads used to build your own directory site need no key.
The base URL for every request is:
Always use HTTPS, so your API key is encrypted on its way to us.
Full-access and read-only keys
Your organization can have two kinds of key:
- A full-access key can read and change everything your organization can.
- A read-only key can only read. It cannot make changes, and it cannot read API keys, webhook signing secrets or webhook addresses, because those work as credentials.
Use a read-only key wherever a key only needs to read, and keep every key on your server, never in browser code.
Rate limits
Each API key can make up to 1,000 requests per hour to each endpoint. Two endpoints allow 50 requests per hour: Create a new partner contact request and Create a new directory matchmaking request. Over the limit, the API answers 429 Too Many Requests. Wait and try again.