Issues
Tasks on a project or Backlog issues on a team. Authorization: Bearer ak_.... Required scope includes read:projects. Requests are scoped to one entity. Pass entityId as a query parameter, JSON field, or x-entity-id header. API keys are already pinned to an entity.
Authorization
bearerAuth Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....
In: header
Path Parameters
uuidQuery Parameters
Entity UUID; must match the API key’s entity when using Bearer auth.
uuidResponse Body
application/json
application/json
curl -X GET "https://example.com/api/projects/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/tasks?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "error": "string"}{ "error": "string"}Add a task or Backlog issue. Authorization: Bearer ak_.... Required scope includes write:projects. Requests are scoped to one entity. Pass entityId as a query parameter, JSON field, or x-entity-id header. API keys are already pinned to an entity.
Authorization
bearerAuth Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....
In: header
Path Parameters
uuidQuery Parameters
Entity UUID; must match the API key’s entity when using Bearer auth.
uuidResponse Body
application/json
application/json
application/json
curl -X POST "https://example.com/api/projects/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/tasks?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "error": "string"}{ "error": "string"}{ "error": "string"}Patch a task or Backlog issue. Authorization: Bearer ak_.... Required scope includes write:projects. Requests are scoped to one entity. Pass entityId as a query parameter, JSON field, or x-entity-id header. API keys are already pinned to an entity.
Authorization
bearerAuth Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....
In: header
Path Parameters
uuidQuery Parameters
Entity UUID; must match the API key’s entity when using Bearer auth.
uuidResponse Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/projects/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/tasks?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "error": "string"}{ "error": "string"}{ "error": "string"}Delete a task or Backlog issue. Authorization: Bearer ak_.... Required scope includes write:projects. Requests are scoped to one entity. Pass entityId as a query parameter, JSON field, or x-entity-id header. API keys are already pinned to an entity.
Authorization
bearerAuth Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....
In: header
Path Parameters
uuidQuery Parameters
Entity UUID; must match the API key’s entity when using Bearer auth.
uuidResponse Body
application/json
application/json
application/json
curl -X DELETE "https://example.com/api/projects/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/tasks?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "error": "string"}{ "error": "string"}{ "error": "string"}Flat task list. Pass workScope=internal for Backlog issues. Authorization: Bearer ak_.... Required scope includes read:projects. Requests are scoped to one entity. Pass entityId as a query parameter, JSON field, or x-entity-id header. API keys are already pinned to an entity.
Authorization
bearerAuth Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....
In: header
Query Parameters
Entity UUID; must match the API key’s entity when using Bearer auth.
uuidclient (default) for client Projects jobs; internal for Backlog teams and issues.
Value in
- "client"
- "internal"
Issue key, task UUID, or ref.
uuidbacklog = unscheduled issues; sprint = assigned to a sprint.
Value in
- "backlog"
- "sprint"
Response Body
application/json
application/json
curl -X GET "https://example.com/api/projects/tasks?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "error": "string"}{ "error": "string"}