ScheduleGroups

Lists schedule groups with their active members, one page at a time.

Groups are flat with a parentGroupId; nest them client-side. Example: GET /api/v1/schedule-groups?parentGroupId=3 returns the crews of division 3. Also available as CSV (Accept: text/csv or ?format=csv); paging cursor in X-Next-Cursor.

get/api/v1/schedule-groups

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/schedule-groups
  • Auth: HTTP bearer

Query parameters

afterstring

SyncId of the last item of the previous page; omit for the first page.

limitinteger

Page size, 1–200 (default 50).

updatedSincestring date-time

Only groups created or edited at/after this UTC instant (ISO-8601). Adding or removing a member counts as an edit.

parentGroupIdinteger

Only direct children of this group; pass 0 for top-level groups only.

format'csv'

Alternative to the Accept header: csv returns text/csv.

Response

A page of groups.

nextCursorstring nullable

SyncId of the last item; pass it back as ?after= to fetch the next page. null when this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.