GET Plans
Query parameters
limit |
|
offset |
|
sortBy |
See Paging parameters |
sortDirection |
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"
}