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:
title,
-title,
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.
  • status_in: Filter by goal status (planned, active, achieved, cancelled).
  • parent_goal_in: Filter by parent goal ID.

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_goal,
owner_agent

Response

List of plane goals.

JSON API response object

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

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

A plane goal for tracking objectives and sub-goals