Base URL
Authentication
Every request must include a Personal Access Token in theAuthorization
header:
Ability | Description |
---|---|
workspaces-read | Read workspaces the user belongs to |
workspaces-write | Create, update or delete workspaces |
workspace-users-read | List workspace members & invites |
workspace-users-write | Manage workspace members & invites |
forms-read | Read forms & submissions |
forms-write | Create or modify forms & submissions |
Pagination
Some list endpoints are paginated. Use thepage
query parameter (?page=2
) to retrieve subsequent pages.
Rate limits
Each IP address is limited to 100 requests per minute. Exceeding the limit returns 429 Too Many Requests.Errors
Errors are returned in JSON with an HTTP status code that reflects the problem:Status | Meaning |
---|---|
400 | Bad request / validation error |
401 | Missing or invalid token |
403 | Token lacks required ability |
404 | Resource not found |
429 | Rate limit exceeded |
500 | Server error – something went wrong on our side |