Qamaq API Documentation

Build powerful integrations with the Qamaq API. Access entities, knowledge base, workflows, and more.

Quick Start

Get your API Key

Navigate to Configurations > API Keys in your Qamaq dashboard to create a new API key. Make sure to copy it immediately as it won't be shown again.

Make your first request

Use your API key in the Authorization header with the Bearer scheme:

Example Requestbash

curl -X GET "https://api.qamaq.io/api/v1/entities" \
  -H "Authorization: Bearer qmq_your_api_key"

Explore the API

Browse our API reference below to discover all available endpoints and capabilities.

API Capabilities

API Key Authentication

Secure your requests using API keys with Bearer token authentication.

Boards

Access and manage Kanban boards with columns and workflow stages.

Tickets

Create, update, move, and manage tickets on your Kanban boards.

Custom Entities

Create, read, update, and delete custom entities and their records.

Folders

Organize your knowledge base with folders and hierarchical structures.

Files

Upload, manage, and retrieve files in your knowledge base.

Semantic Search

Perform AI-powered semantic search across your knowledge base.

Webhooks

Configure webhooks to receive real-time event notifications.

Base URL

All API requests should be made to:

https://api.qamaq.io/api/v1

API Versioning

The API version is included in the URL path. The current stable version is v1.

We will announce any breaking changes well in advance and maintain backward compatibility where possible.

Rate Limiting

The API implements rate limiting to ensure fair usage. Current limits:

1000

requests/minute

10,000

requests/hour

100,000

requests/day

Note: Rate limit headers are included in all responses. If you exceed the limit, you'll receive a 429 Too Many Requests response. Contact us if you need higher limits.

Error Handling

The API uses standard HTTP status codes to indicate success or failure of requests:

200OKRequest succeeded

201CreatedResource created successfully

400Bad RequestInvalid request parameters

401UnauthorizedMissing or invalid API key

403ForbiddenAPI key lacks required permissions

404Not FoundResource not found

422Validation ErrorRequest validation failed

429Too Many RequestsRate limit exceeded

500Server ErrorInternal server error

Need Help?

Our team is here to help you integrate with the Qamaq API.

Contact Support View Documentation