An overview of how to use the Claimable API Reference.

The API Reference section of the Claimable Developer Hub provides object and endpoint definitions: everything you need to start building your integration!

📖 API Objects

The Objects section explains the various objects made available via the API. An object defines the attributes and structure of a given record type, such as a Claim, Contact, Company, Note etc.

Each object definition lists its available attributes, along with descriptions and examples to help you plan your integration.

🔀 API Endpoints

The Endpoints section lists all the endpoints and corresponding operations available via the API.

Endpoints are categorised into groups based on the object they relate to, such as Claims, Contacts, Companies etc. and each one shows the URL and operation that can be performed (e.g. GET, POST etc.).

There are examples of every request and you can even try API requests directly from the web browser, as explained below.

🌏 Using the API Explorer

The API Reference includes a convenient API explorer feature that lets you try requests directly from the browser!

To use it, click on the auth button next to the "Try It" button, which shows alongside every endpoint URL. Enter your API token in the "Bearer" field.

Then click Try It, to execute the request and the response will show directly in the sidebar.

723723

📘

Tip: Set Attribute Values

When making POST or PATCH requests you can enter values in the list of attributes for each endpoint, which will conveniently construct the correct JSON payload for your request.

You can copy the JSON directly or use the built-in API Explorer to test creating and updating objects.

🚧

Need an API Token?

If you don't already have an API token, visit the Getting an API Token section to get started.

🖥 Using an Dedicated API Explorer Tool or Application

The built-in API explorer on each endpoint page is convenient for quick tests and experiments, but when developing your project you will want a more comprehensive way to make API requests.

You can always make API requests via the terminal using a command line tool such as curl, but there are several purpose-built applications designed to make exploring API's far easier through a visual interface, without the need to write much code.

We recommend Postman, but there are many alternatives for all major platforms.