Cirkus REST API Quick Start

Cirkus is a powerful tool for project management and team collaboration. The REST API allows developers to integrate Cirkus functionalities into their own applications. This guide provides a quickstart for getting up and running with the Cirkus REST API.

Base URL
All API requests for are made to the following base URL:
For private clouds please check with our support team.

You will need an API Key to use the REST API endpoints.
On the API Key must belong to a Cirkus user who is a member of a Cirkus Pro Workspace.
We recommend using a dedicated system account for API integrations, to avoid issues with user lifecycle management.

Getting an API Key

  1. Log in to the integration users Cirkus account on web or Cirkus mac application.
  2. Navigate to your User Preferences via the Settings link at the bottom of the left menu
  3. Click on the API Keys tab.
  4. Type a name for your API key and click on Add Key
  5. Now you can copy the key to your Clipboard

Include the following headers in all your API requests:

Content-Type: application/json

Example Request
Here’s an example using `curl` to list projects:
curl -X GET \
-H "Cirkus-API-Key: YOUR_API_KEY" \
-H “Content-Type: application/json”

Error Handling
Cirkus API uses standard HTTP status codes to indicate the success or failure of an API request.
200 OK: The request was successful.
201 Created: A new resource was successfully created.
400 Bad Request: The request was invalid or cannot be served.
401 Unauthorized: Authentication failed or user ( the owner of the API Key) does not have permissions.
403 Forbidden: User ( the owner of the API Key) does not have access to the requested resource
404 Not Found: The requested resource could not be found.
5XX Internal Server Error: An error occurred on the server.

Detailed API documentation
For detailed information on endpoints and functionalities, the latest Cirkus API documentation is published on SwaggerHub at

If you need support with other endpoints or technical assistance please contact, and our team will be happy to help.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.