Introduction

API


The ClinchPad API is a RESTful API designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. JSON will be returned in all responses from the API, including errors.

Authentication


You authenticate to the ClinchPad API by providing your API keys in the request. You can get your API key from the Settings section of the ClinchPad web app. Please ensure that you keep your API key a secret since anyone can access your account with your API key, just like they could if they obtained your login password and username. Authentication to the API occurs via HTTP Basic Auth.

Provide 'api-key' as your basic auth username and your API key as your password. A sample request using curl is show below

curl -X GET https://www.clinchpad.com/api/v1/leads
-u "api-key:4e65146b302a2a2ec8135aa6dc501a17"

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests.

Rate Limiting Requests


To prevent abuse, requests to the ClinchPad API are rate limited at 1200 calls/hour. If your account is over the limit, you will get back a response containing a 429 HTTP response code.

It is strongly suggested that you check for the 429 HTTP response code in your responses. If you have a large number of requests, we suggest implementing a request queue.

Errors


ClinchPad uses HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a lead was not found etc.), and codes in the 5xx range indicate an error with ClinchPad's servers.

A descriptive error message is returned in JSON along with the HTTP response code.

Questions?


If you have any questions about using the ClinchPad API, please don't hesitate to shoot us an email at [email protected] . We would love to hear from you!