🔠 Request Headers

Every request you make to the Claimable API should include the following request headers.

Header Name	Value	Description
`Accept`	`application/json`	Tells the API to respond with the JSON format. The Claimable API only supports JSON.
`Authorization`	`Bearer {{YOUR_API_TOKEN}}`	Authenticates your API request with the provided API token.
`Content-Type`	`application/json`	When making PATCH or POST request add this header to tell the Claimable API you're sending a JSON payload.

🔀 Methods

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.

ℹ️ URL

All API request URLs comprises three parts: API Base + Endpoint Path + Query Parameters

URL Component	Value	Description
Base URL* (required)	`https://api.claimable.com`	The base for all API requests. Must use `https://`.
Endpoint Path* (required)	`/{{ENDPOINT_PATH}}` (e.g.`/claims`)	A path pointing to a supported endpoint. See the full list in the API Reference.
Query Parameters* (optional)	`?{{PARAM}}={{VALUE}}...` (e.g.`s=smith`)	If supported by the endpoint, you can optionally pass additional information to the API as query parameters in the request URL.

Examples:

https://api.claimable.com/claims/12345
https://api.claimable.com/contacts
https://api.claimable.com/claims/12345/notes

📘
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.