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
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

sort
enum<string>[]

A comma separated list of fields to sort by.

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

Filters the response data based on the value provided.

Available filters:

  • in(organisation,[xxx]): Filter where the organisation ID is in the provided list.
  • in(status,[xxx]): Filter by plan status.
  • in(goal,[xxx]): Filter by goal ID.
  • in(project,[xxx]): Filter by project ID.
  • in(issue,[xxx]): Filter by issue ID.
  • in(author_agent,[xxx]): Filter by author agent ID.
  • in(author_user,[xxx]): Filter by author user ID.
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
goal,
project,
issue,
author_agent,
author_user,
previous_version

Response

List of plane plans.

JSON API response object

data
A list of plane plans · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a plane plan is returned

A plane goal for tracking objectives and sub-goals