API ReferenceTurns

List Turns

Deprecated
<Badge>Available by Request</Badge> List all turns <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of turns
scheduledDatestringformat: "date"
actualEndDatestring or nullformat: "date"
actualStartDatestring or nullformat: "date"
createdAtdatetime or null
deletedAtdatetime or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
organizationIdstring or nullformat: "uuid"
readableIdstring or null
scheduledEndDatestring or nullformat: "date"
scheduledStartDatestring or nullformat: "date"
statusenum or null
Allowed values:
unitobject or null
unitIdstring or nullformat: "uuid"
updatedAtdatetime or null