Skip to main content

Overview

Interactive API Testing with Postman

Want to test our APIs without writing code? Download our Postman Collections for visual, GUI-based API exploration. Perfect for:

  • ๐ŸŽฏ Support engineers debugging issues
  • ๐Ÿ’ผ Sales teams doing live demos
  • ๐Ÿค Partners exploring the API
  • ๐Ÿงช QA teams testing endpoints

๐Ÿ‘‰ Download Postman Collections โ†’

tip

API keys are generated under the platform dashboard at this moment to manage multiple projects, which is only available in the Platform and Enterprise editions, Please contact sales@staqr.com for more information.

Authentication:โ€‹

The API uses "API keys" to authenticate requests. You can view and manage your API keys from the Platform Dashboard. After creating the API keys, you can pass the API key as a Bearer token in the header.

Example: Authorization: Bearer {API_KEY}

Paginationโ€‹

All endpoints use seek pagination, to paginate through the results, you can provide the limit and cursor as query parameters.

The API response will have the following structure:

{
"data": [],
"next": "string",
"previous": "string"
}
  • data: Holds the requested results or data.

  • next: Provides a starting cursor for the next set of results, if available.

  • previous: Provides a starting cursor for the previous set of results, if applicable.