Plan Profiles

Endpoints used for managing plan profiles.

Operations

List the existing plan profiles

Request

Retrieve plan profiles using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).

Security

clientCredentials

Query

cursorstring

The cursor of the page to retrieve. No cursor is needed to retrieve the first page.

limitinteger, (int32), [ 1 .. 1000 ]

The maximum amount of plan profiles that should be returned in the response

Default:100

Example:limit=250

curl -i -X GET \
  'https://developer.conundra.eu/_mock/apis/plannings/planning-api/plan-profiles?cursor=string&limit=250' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

dataArray of objects(PlanProfileListSummary)required

The set of results for the current page.

cursorsobject(CursorsWithOnlyNext)required

Cursor that only supports next cursor navigation.

Response

{
  "data": [
    { … }
  ],
  "cursors": {
    "next": "bmV4dF9fcGFnZQ"
  }
}