GET Plans

Overview

The plan list endpoint returns plans in a group. A valid group UUID is required.

Base path

/api/v1/groups/GROUP_UUID/plans

Path parameters

GROUP_UUID

(string) The unique identifier for a group.

Query parameters

limit

See Paging parameters

offset

See Paging parameters

sortBy

See Paging parameters
Available values: NAME
NAME - the internal name of the plan
Default: NAME

sortDirection

See Paging parameters

Curl example

curl -X GET \
'https://API_HOSTNAME/api/v1/groups/GROUP_UUID/plans? \
sortBy=NAME&sortDirection=ASC&limit=5&offset=5' \
--header 'Authorization: Bearer BEARER_TOKEN'

Response

The response is a list of plans, with additional fields that contain paging metadata and links to the previous and next pages, if they exist.

Response body

{
    "totalCount": 11,
    "limit": 5,
    "offset": 5,
    "results": [
        {
            "uuid": "PLAN_UUID",
            "name": "Plan Six"
        },
        {
            "uuid": "PLAN_UUID",
            "name": "Plan Seven"
        },
        ...
    ],
    "nextPage": "https://API_HOSTNAME/api/v1/groups/GROUP_UUID/plans?sortBy=NAME&sortDirection=ASC&offset=10&limit=5",
    "previousPage": "https://API_HOSTNAME/api/v1/groups/GROUP_UUID/plans?sortBy=NAME&sortDirection=ASC&offset=0&limit=5"
}

Result attributes

uuid

(string) A unique identifier for the plan.

name

(string) The name of the plan.