Make your first API request

Use the Kaneo API for scripts and integrations. Requests go to your instance’s public API URL, usually https://kaneo.example.com/api.

Working from a terminal? The Kaneo CLI covers the same tasks with JSON output for scripts and agents, and kaneo api sends a request to any endpoint with your stored login.

1. Create an API key

Open Settings → Account → API Keys in Kaneo and create a key for your script. Copy it when it is shown. See Authentication for API keys and device authorization. Keep keys in server-side scripts or secret storage. Do not put a personal API key in frontend JavaScript shipped to other users.

2. Find your workspace and project IDs

Set KANEO_API_KEY in your shell using your secret manager or a private environment file. Then list the workspaces you belong to with GET /api/workspace. Each item includes the workspace id, name, slug, and your role:

curl --fail-with-body 'https://kaneo.example.com/api/workspace' \
  -H "Authorization: Bearer $KANEO_API_KEY"

You can also open a project in the browser. Its URL includes both IDs:

/dashboard/workspace/WORKSPACE_ID/project/PROJECT_ID/board

Use the IDs, not the workspace name or a task number such as WEB-22.

3. List the workspace’s projects

Replace the example workspace ID:

curl --fail-with-body --get 'https://kaneo.example.com/api/project' \
  --data-urlencode 'workspaceId=WORKSPACE_ID' \
  -H "Authorization: Bearer $KANEO_API_KEY"

A successful response is a JSON array of projects. Use a project’s id in the next request.

4. Read the project’s tasks

curl --fail-with-body \
  'https://kaneo.example.com/api/task/tasks/PROJECT_ID?page=1&limit=50' \
  -H "Authorization: Bearer $KANEO_API_KEY"

This endpoint returns a project board, including columns and task buckets, together with pagination metadata. It is not a flat task array. Follow pagination.totalPages for task pages and pagination.relatedTotalPages for related metadata pages when those span multiple pages. For a single task, request GET /api/task/TASK_ID. Check the endpoint reference for the exact response and supported filters. Large descriptions can be deferred from list results, so fetch task details when you need the full text.

Handle errors

Status	What to check
400	Required IDs, query parameters, and request body
401	Missing, invalid, or expired credentials
403	Your role’s permission for the requested action, or your access to a restricted project
404	The resource ID, the endpoint path, and your membership in the resource’s workspace
429	Rate limits; wait before retrying
5xx	Instance logs and service health

Resources in a workspace you are not a member of return 404, the same response as a resource that does not exist. Error bodies are JSON with a human-readable message and a stable code. See Errors for the codes, validation issues, and missing permissions. Do not retry a mutation blindly when you are unsure whether it already succeeded.

API reference

The endpoint pages are generated from the repository’s OpenAPI specification. A running instance exposes its own schema at /api/openapi, which is the best match for that instance’s installed version. Most application endpoints require authentication. Public endpoints, including health and sign-in routes, have their own requirements. Authentication never grants access to every workspace automatically.

Start building

Command line

Endpoint reference

Make your first API request

1. Create an API key

2. Find your workspace and project IDs

3. List the workspace’s projects

4. Read the project’s tasks

Handle errors

API reference

​1. Create an API key

​2. Find your workspace and project IDs

​3. List the workspace’s projects

​4. Read the project’s tasks

​Handle errors

​API reference

1. Create an API key

2. Find your workspace and project IDs

3. List the workspace’s projects

4. Read the project’s tasks

Handle errors

API reference