Developers
Getting Started
Get started with the Cliq API and developer tools
Getting Started with the Cliq API
Build integrations and automate workflows with the Cliq API.
Overview
The Cliq API allows you to:
- Create, read, update, and delete issues
- Manage projects and workspaces
- Automate workflows with webhooks
- Build custom integrations
Authentication
All API requests require authentication using an API key.
Creating an API Key
- Go to Settings → API
- Click Create API Key
- Give your key a descriptive name
- Select the permissions you need
- Click Create
- Copy your API key (you won't see it again!)
Using Your API Key
Include your API key in the Authorization header:
curl -X GET "https://api.cliq.no/v1/issues" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Base URL
All API requests are made to:
https://api.cliq.no/v1Making Your First Request
Let's fetch all issues in your workspace:
curl -X GET "https://api.cliq.no/v1/issues" \
-H "Authorization: Bearer YOUR_API_KEY"Response:
{
"data": [
{
"id": "issue_123",
"title": "Fix login bug",
"status": "in_progress",
"priority": "high",
"assignee": "user_456",
"created_at": "2025-01-15T10:30:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 1
}
}Common Endpoints
Issues
| Method | Endpoint | Description |
|---|---|---|
| GET | /issues | List all issues |
| POST | /issues | Create an issue |
| GET | /issues/:id | Get an issue |
| PATCH | /issues/:id | Update an issue |
| DELETE | /issues/:id | Delete an issue |
Projects
| Method | Endpoint | Description |
|---|---|---|
| GET | /projects | List all projects |
| POST | /projects | Create a project |
| GET | /projects/:id | Get a project |
| PATCH | /projects/:id | Update a project |
| DELETE | /projects/:id | Delete a project |
Error Handling
The API uses standard HTTP status codes:
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Rate Limited |
| 500 | Server Error |
Error responses include a message:
{
"error": {
"code": "invalid_request",
"message": "The 'title' field is required"
}
}SDKs and Libraries
We provide official SDKs for popular languages:
- JavaScript/TypeScript -
npm install @workspace/sdk - Python -
pip install cliq-sdk - Go -
go get github.com/cliq/cliq-go
JavaScript Example
import { CliqClient } from '@workspace/sdk';
const cliq = new CliqClient({ apiKey: 'YOUR_API_KEY' });
// Create an issue
const issue = await cliq.issues.create({
title: 'New feature request',
description: 'Add dark mode support',
priority: 'medium',
});
console.log(issue.id);Next Steps
- Learn about Rate Limiting
- Set up Webhooks for real-time updates
- Explore the full API reference (coming soon)