💡 Accessing the API

Our API is available to all our users on the Established price plan. If you would like to start using the API or upgrade your price plan, just contact us via the right-hand corner chat bubble or at [email protected].

💡 The API Token

To start using our API or our Zapier integration you will need an API token to authenticate. To obtain an API token, request it via customer support at [email protected] or use the in-app chat.

💡 Using Multiple API Tokens

We encourage you to assign each API token to a specific project, integration, or application. This practice will help you manage your tokens more efficiently, keep your projects organised and make it easy to revoke individual tokens if needed.

For example, if you are using our API to send claims data from Claimable to a business intelligence (BI) platform and also to send a Slack notification when a supplier is appointed, you should use two different API tokens. This will reduce complexity, increase maintainability and maximise security.

💡 Matching an Existing Contact when Creating a Claim

When creating a claim, you can specify an existing contact as the claimant or insured party. To do this, set match_existing to true in your payload and include the contact's email address. This will help Claimable accurately identify the correct contact and avoid duplicates.

💡 Unique Identifier

When updating a record in Claimable such as a claim, a contact or a company, you will need to use the id as the unique identifier. The id you need can be found in the URL when viewing a record within Claimable.

You can also retrieve the id of claims, for example, by using the List & Search endpoint to retrieve all claims in your account. This approach can also be used for other records.

💡 Getting Access to Zapier

Our Zapier integration is currently accessible by invitation only. If you're interested in gaining access to our Zapier app, please reach out to customer support at [email protected] or use the in-app chat.

💡 Using Claim, Incident, Sub-incident and Damage Types Keys

When specifying the claim, incident, sub-incident or damage type in your payload, these will need to be entered as strings representing keys. These can be found in the claim and incident types key document which our team will send to you along with your API token. If you have not received this document yet, just contact us, and we will send it to you right away.