Rosters

One roster per location per week. Reading never creates one: a week nobody has rostered yet returns nothing. Rosters are published in Shiftly.

Needs the roster:read permission, depending on the operation. The business sees it as "Rosters and shifts".

Fields

Roster fields
Field	Type	Access	Meaning
id	string	Read-only	The roster week.
location_id	string	Read-only	The location the roster is for.
start_date	date	Read-only	First day of the week, in the location's timezone.
end_date	date	Read-only	Last day of the week, in the location's timezone.
status	"draft", "unpublished", "published"	Read-only	draft (never published), unpublished (changed since it was last published) or published.
published_at	timestamp, may be null	Read-only	When the roster was last published.
archived	boolean	Read-only	True when the record has been removed in Shiftly.
created_at	timestamp	Read-only	When the record was created.
updated_at	timestamp	Read-only	When the record last changed.

Operations

List rosters

GET/v1/rosters

Permission: roster:read

Query parameters
Parameter	Type		Meaning
limit	integer, default 50, up to 200	Optional	How many records per page. Up to 200.
after	string	Optional	The next_cursor from the previous page.
updated_since	timestamp	Optional	Only records changed at or after this moment. Pair it with include_archived to see removals.
include_archived	"true", "false"	Optional	Include records that have been archived.
from	date	Optional	The first day of the range, in the location's timezone. With to, at most 92 days.
to	date	Optional	The last day of the range, inclusive.
location_id	string	Optional	Only this location.

200 response

{
  "data": [
    {
      "id": "66f1c2a4b3d9e8f7a6b5c4d3",
      "location_id": "66f1c2a4b3d9e8f7a6b5c4d3",
      "start_date": "2026-10-06",
      "end_date": "2026-10-06",
      "status": "draft",
      "published_at": "2026-10-06T09:00:00+11:00",
      "archived": true,
      "created_at": "2026-10-06T09:00:00+11:00",
      "updated_at": "2026-10-06T09:00:00+11:00"
    }
  ],
  "has_more": true,
  "next_cursor": "text"
}

Refusals
Status	When
400	The error's code is invalid_request or range_too_long. The Errors page describes each code.
401	The error's code is invalid_token or token_expired. The Errors page describes each code.
403	The error's code is origin_not_allowed, permission_denied, not_available, connection_disconnected, connection_suspended or app_suspended. The Errors page describes each code.
404	There is nothing at this address, or no such record in this business.
429	Too many requests. Retry-After says when to try again.
500	Something went wrong at Shiftly. Quote the request id.
503	This environment is not set up for partner apps yet.

Get one roster

GET/v1/rosters/{id}

Permission: roster:read

200 response

{
  "id": "66f1c2a4b3d9e8f7a6b5c4d3",
  "location_id": "66f1c2a4b3d9e8f7a6b5c4d3",
  "start_date": "2026-10-06",
  "end_date": "2026-10-06",
  "status": "draft",
  "published_at": "2026-10-06T09:00:00+11:00",
  "archived": true,
  "created_at": "2026-10-06T09:00:00+11:00",
  "updated_at": "2026-10-06T09:00:00+11:00"
}

Refusals
Status	When
400	The error's code is invalid_request or range_too_long. The Errors page describes each code.
401	The error's code is invalid_token or token_expired. The Errors page describes each code.
403	The error's code is origin_not_allowed, permission_denied, not_available, connection_disconnected, connection_suspended or app_suspended. The Errors page describes each code.
404	There is nothing at this address, or no such record in this business.
429	Too many requests. Retry-After says when to try again.
500	Something went wrong at Shiftly. Quote the request id.
503	This environment is not set up for partner apps yet.