Skip to main content

​
API Documentation

​
Getting Started

Understanding the basics of CaptureIQ’s API.
Please note that CaptureIQ’s API is currently in beta. We welcome any questions or feedback you may have. Feel free to reach out to us at [email protected].

​
Base URL

The CaptureIQ API is built on REST principles and is served over HTTPS. The Base URL for all API endpoints is: 
https://app.captureiq.ai

​
Authentication

To access CaptureIQ’s API, you need to authenticate using a Bearer token. Include the token in the Authorization header of your API requests like this: 
Authorization: Bearer <Your-Token>
You can generate a new token/API key under your Account Settings. This token is valid for 180 days, post that need to generate a new key in settings Hero Light

​
Workspace ID

CaptureIQ’s API is organized around workspaces. To access a workspace’s resources, include the workspaceId parameter in your API requests either in the query param or request body: 
https://app.captureiq.ai/forms?workspaceId=<Your-Workspace-ID>
You can get your workspace ID under your Settings. Hero Light

​
Response Codes

The API returns standard HTTP response codes to indicate the success or failure of an API request. Here are a few examples:
CodeDescription
200The request was successful.
400The request was invalid or cannot be served.
401The request requires user authentication.
403The server understood the request, but refuses to authorize it.
404The requested resource could not be found.
429Too many requests.
500The server encountered an unexpected condition which prevented it from fulfilling the request.

​
Rate limits

CaptureIQ’s API enforces a rate limit of 60 requests per minute per user. This limitation is in place to promote fair usage and prevent any single user from disproportionately impacting the performance and availability of the API for others. If you exceed the rate limit, you will receive a 429 Too Many Requests response code. This indicates that your request cannot be processed at the moment due to exceeding the allowed number of requests within the specified timeframe.