Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
number,
-number,
title,
-title,
status,
-status,
priority,
-priority,
created_at,
-created_at
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • organisation_in: Filter where the organisation ID is in the provided list.
  • project_in: Filter where the project ID is in the provided list.
  • status_in: Filter by issue status (backlog, todo, in_progress, done, cancelled).
  • priority_in: Filter by issue priority (none, urgent, high, medium, low).
  • assignee_agent_in: Filter by assignee agent ID.
  • closed_in: Filter by closed state (true, false).

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
parent_issue,
assignee_agent

Response

List of agent issues.

JSON API response object

data
A list of agent issues · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when an agent issue is returned

An agent issue