Partner API
The Partner API is a REST API for the integrations of a Partner. An integration reads the data of your Partner and your customers, links a customer and changes the settings of a customer.
The Swagger UI of the Partner API gives each endpoint, its parameters and its responses. You can also send a test request from it: Partner Portal v1 API.
Base URL
Section titled “Base URL”https://partners.theoneclick.io/api/v1
Authentication
Section titled “Authentication”Send your Partner API key in the token header of each request. A team member generates the key on the
Settings page. See Manage the Partner API key.
The key gives access only to the data of your Partner and your customers.
In the Swagger UI, click Authorize and paste the key. Try it out then sends the key with each request.
The Partner API key is not the transfer-enabled API key of OneClick. See The Partner API key is not the transfer-enabled API key.
Endpoints
Section titled “Endpoints”| Method | Path | What it does |
|---|---|---|
GET |
/partner |
Gets the details of your Partner, without the key. |
GET |
/partner/users |
Gets the users of the Pipedrive company of your Partner. |
GET |
/customers |
Gets your customers. |
GET |
/customers/{id} |
Gets one customer. |
POST |
/customers |
Links a Pipedrive company to your Partner as a customer. |
PATCH |
/customers/{id} |
Changes the settings of a customer. It cannot upload a logo. |
GET |
/users/{organizationId} |
Gets the users of one customer. |
Errors
Section titled “Errors”| Status | Message | Cause |
|---|---|---|
| 401 | Token is missing |
The request has no token header. |
| 401 | Token not match |
No Partner has this key. The key is wrong or revoked. |
| 400 | Missing partner's own organization |
Your Partner has no linked Pipedrive company. Contact Zimple support. |