Skip to main content
GET
Retrieve the list of plans, in a light representation

Authorizations

Authorization
string
header
required

JWT bearer token, sent as Authorization: Bearer <token>. Two kinds of token are accepted:

  • A session token (1 hour), obtained through the interactive Console login flow. Used to sign in to the Console; not meant to be used against this API.
  • A long-term API token (366 days), obtained once via the Console and meant to be stored by your integration. It is the credential recommended for backend use, since it does not depend on repeating the interactive login flow.

Query Parameters

page
integer
default:1

The page number of a paginated list of records.

Required range: x >= 1
Example:

1

itemsPerPage
integer
default:20

The number of items per page in a paginated list of records.

Required range: 1 <= x <= 100
Example:

30

archived
enum<string>
default:excluded

Indicates if and how archived items should be part of the result.

Available options:
excluded,
included,
only

Response

Plan collection response in a light representation.

A page of light-representation plans, as returned by the plan-listing endpoint.

items
object[]

Plans on this page.

agencyId
string

Identifier of the Kardinal tenant/account the plan is scoped to, derived automatically from the access token used to make the request.

Modelling pitfall. Not a physical-depot or site partition key. A single fleet based at several physical depots is still one Plan; do not split it into several Plan objects just because resources have different departure/arrival positions.

Pattern: ^BLD[0-9]{7}_[a-zA-Z0-9-._~:@!$,]+$
Example:

"BLD1234567_production"

paging
object

Pagination metadata attached to a paged list response.