Getting started with our REST API
Welcome to our REST API! This guide provides a quick overview to help you get started with integrating our API into your applications.
Setting up your API key
- Obtain your API key: Log into the application, navigate to the settings, and locate the API section. Copy your API key.
- Authentication: To authenticate your requests, add the API Key as a Bearer token in the header of each request.
- Format:
Authorization: {API_KEY}
Understanding pagination
Our API uses pagination to manage large sets of data efficiently.
- Basic concept: Instead of returning all records at once, pagination breaks the data into “pages” with a specified number of records per page.
- Parameters:
page: The current page number you are accessing.page_size: The number of records per page.- Using pagination: When querying endpoints that return multiple items (like lists or events), use these parameters to navigate through your data.
Webhooks
Webhooks allow you to receive real-time updates for specific events in your system.
- Setup: Provide a Webhook URL and a secret token in the application settings. This URL is where the application will send updates.
- Receiving Updates: When an event occurs, our system will send a POST request to your Webhook URL with relevant data.
Sample use cases
- Retrieving data with pagination:
- To get the third page of a list with 10 records per page, you would make a request to an endpoint like
/lists?page=3&page_size=10.
- Updating data:
- Use the relevant PUT or POST endpoint, include the Bearer token for authentication, and send your update payload.
Getting further help
- Documentation: For detailed information, refer to our API documentation available in Redoc and Postman collections.
- Support: If you encounter any issues or have questions, feel free to reach out to our support team.
This guide aims to provide you with the necessary tools to start interacting with our API quickly. Dive in and explore the various features and capabilities at your disposal!