The headers, methods and URL needed to configure your API requests.
🔠 Request Headers
Every request you make to the Claimable API should include the following request headers.
|Tells the API to respond with the JSON format. The Claimable API only supports JSON.|
|Authenticates your API request with the provided API token.|
|When making PATCH or POST request add this header to tell the Claimable API you're sending a JSON payload.|
The Claimable API supports only the following HTTP methods to perform the corresponding operation for the given endpoint.
|HTTP Method||API Operation|
|GET||Fetch a resource/s.|
|POST||Create a resource.|
|PATCH||Update a resource. Accepts partial updates of only the provided attributes.|
|DELETE||Deletes a resource.|
All API request URLs comprises three parts:
API Base +
Endpoint Path +
|Base URL (required)||The base for all API requests. Must use |
|Endpoint Path (required)|
|A path pointing to a supported endpoint. See the full list in the API Reference.|
|Query Parameters (optional)|
|If supported by the endpoint, you can optionally pass additional information to the API as query parameters in the request URL.|
What are Query Parameters
You can use query parameters to provide additional context to the API in the form of variables (key/value pairs) appended to the endpoint URL.
You should never send sensitive/private information as query parameters.
Updated over 2 years ago