ScheduleGroups

Returns one schedule group with its active members.

Send the previous ETag as If-None-Match to receive 304 Not Modified when unchanged.

get/api/v1/schedule-groups/{id}

Request

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

Path parameters

idinteger required

Schedule group id. Example: 3.

Response

The group, with an ETag header.

idinteger

Numeric id of the group. Stable within this organization.

syncIdstring uuid

Globally unique sync id (GUID). Use it as the after pagination cursor.

namestring

Group name, e.g. "Install Crew A".

descriptionstring nullable

Optional description shown on the dispatch board.

colorHexstring nullable

Hex colour used for calendar / board rendering, e.g. "#2e7d32"; null when unset.

parentGroupIdinteger nullable

Id of the parent group (e.g. the division a crew belongs to); null for top-level groups.

parentGroupNamestring nullable

Name of the parent group; null for top-level groups.

displayOrderinteger

Sort position among siblings (ascending). Pages are returned in id order, so sort by this client-side when rendering a board.

createdAtstring date-time

UTC creation timestamp.

updatedAtstring date-time nullable

UTC timestamp of the last edit; null when never edited.

Changes

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