API Documentation

API Reference

Developer FAQs

Whats the difference between V0 and V1

V0 was the initial API we created while building our MVP, we no longer recommend using our V0 endpoints as we plan to sunset it towards the end of 2024. V1 is the most up to date API we offer and is actively supported.

Do you have a Sandbox for API testing?

We do have a sandbox testing environment however due to the complexities of interacting with mobile devices through remote services the blocking events will not work. If you need access to our Sandbox env for user and account testing then contact our support and we'll get you set up.

Can you help us build our integration?

Our team has a wide range of experience in building applications in all sorts of languages, if you require assistance then please contact support and we'll be happy to lend a hand.

Are the API endpoints rate limited?

Yes, requests are rate limited to 5 requests per second. Exceeding this limit will result in a temporary 1 minute ban, during this time the server will return 429 Too Many Requests response.

Can I limit the API key permissions?

Of course, you have full control over your API key permissions, nevertheless we highly discourage using any API key in an insecure environment as it can be used to retrieve sensitive company information.