Get Shifts - Untether Labs

Get Shifts

curl --request GET \
  --url https://app.untetherlabs.com/api/v1/shifts \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2024-11-20T07:43:34+0000",
      "startDate": "2024-11-20T07:43:34+0000",
      "endDate": "2024-11-20T07:43:34+0000",
      "segments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2024-11-20T07:43:34+0000",
          "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isBreak": false,
          "isOnCall": false,
          "type": "working",
          "startDate": "2024-11-20T07:43:34+0000",
          "endDate": "2024-11-20T07:43:34+0000",
          "labels": [
            "<string>"
          ],
          "importedId": "<string>",
          "roleImportedId": "<string>",
          "additionalInfo": "<unknown>",
          "skillRequirement": {
            "type": "equal",
            "skill": "<string>",
            "value": "<string>"
          }
        }
      ],
      "workRuleOverride": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "note": "<string>",
      "isExternal": true
    }
  ],
  "cursor": "<string>"
}

GET

shifts

Get Shifts

curl --request GET \
  --url https://app.untetherlabs.com/api/v1/shifts \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2024-11-20T07:43:34+0000",
      "startDate": "2024-11-20T07:43:34+0000",
      "endDate": "2024-11-20T07:43:34+0000",
      "segments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2024-11-20T07:43:34+0000",
          "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isBreak": false,
          "isOnCall": false,
          "type": "working",
          "startDate": "2024-11-20T07:43:34+0000",
          "endDate": "2024-11-20T07:43:34+0000",
          "labels": [
            "<string>"
          ],
          "importedId": "<string>",
          "roleImportedId": "<string>",
          "additionalInfo": "<unknown>",
          "skillRequirement": {
            "type": "equal",
            "skill": "<string>",
            "value": "<string>"
          }
        }
      ],
      "workRuleOverride": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "note": "<string>",
      "isExternal": true
    }
  ],
  "cursor": "<string>"
}

Get shifts within a given time range.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

provider

string<uuid>

team

string<uuid>

startDate

string

Used to inclusively filter shifts whose startDate is later than the provided start time, in yyyy-MM-dd format. Defaults to current date - 1 month.

Example:

"2024-11-20T07:43:34+0000"

endDate

string

Used to exclusively filter shifts whose endDate is earlier than the provided end time, in yyyy-MM-dd format. Defaults to current date + 1 month.

Example:

"2024-11-20T07:43:34+0000"

includeOpen

boolean

default:false

pageSize

number

default:20

Required range: 1 <= x <= 200

cursor

string

Response

items

object[]

required

Show child attributes

items.id

string<uuid>

required

items.createdAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.startDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.endDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.segments

object[]

required

The segments that make up a shift, ordered by startDate.

Show child attributes

items.segments.id

string<uuid>

required

items.segments.createdAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.segments.role

string<uuid> | null

required

The role of the shift. Can be null if the shift is pulled from an external system.

items.segments.isBreak

boolean

required

Used to denote whether or not the provider will be on break during this segment.

Example:

false

items.segments.isOnCall

boolean

required

Example:

false

items.segments.type

enum<string>

required

The type of the segment.

Available options:

working,

paid_break,

unpaid_break,

on_call

items.segments.startDate

string

required

The timestamp of when the shift starts.

Example:

"2024-11-20T07:43:34+0000"

items.segments.endDate

string

required

The timestamp of when the shift ends.

Example:

"2024-11-20T07:43:34+0000"

items.segments.labels

string[]

required

The label IDs associated with this shift segment.

items.segments.importedId

string

If a segment was created in an external system, this is the ID of the segment in that system.

items.segments.roleImportedId

string

DEPRECATED The ID of the role in the external system. Once all roles are migrated to the system, this field will be removed.

items.segments.additionalInfo

any

DEPRECATED Additional information about the segment.

items.segments.skillRequirement

object

Option 1
Option 2

Show child attributes

items.segments.skillRequirement.type

enum<string>

required

Available options:

equal

items.segments.skillRequirement.skill

string

required

Minimum string length: 1

items.segments.skillRequirement.value

string

required

items.workRuleOverride

string<uuid> | null

required

items.provider

string<uuid>

The provider of the shift. If null, the shift is an open shift.

items.team

string<uuid>

The team that the shift is associated with.

items.note

string

A note about the shift. Visible to providers.

items.isExternal

boolean

Whether the shift is on an external team.

cursor

string

Get Pay Code Get Teams

⌘I

V1

Authorizations

Query Parameters

Response