Get Shift

curl --request GET \
  --url https://api.stackone.com/unified/hris/shifts/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "employee_id": "emp_123456789",
    "location_id": "loc_123456789",
    "company_id": "comp_123456789",
    "start_time": "2024-03-20T09:00:00.000",
    "end_time": "2024-03-20T17:00:00.000",
    "break_duration": "PT1H30M",
    "status": {
      "value": "confirmed",
      "source_value": "Confirmed"
    },
    "approval_status": {
      "value": "approved",
      "source_value": "Approved"
    },
    "breaks": [
      {
        "id": "break_123456789",
        "start_time": "2024-03-20T12:00:00Z",
        "end_time": "2024-03-20T13:00:00Z",
        "duration": "PT1H",
        "is_paid": true,
        "created_at": "2024-03-20T10:00:00Z",
        "updated_at": "2024-03-20T10:00:00Z"
      }
    ],
    "created_at": "2024-03-20T08:00:00Z",
    "updated_at": "2024-03-20T08:00:00Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

hris

shifts

{id}

Get Shift

curl --request GET \
  --url https://api.stackone.com/unified/hris/shifts/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "employee_id": "emp_123456789",
    "location_id": "loc_123456789",
    "company_id": "comp_123456789",
    "start_time": "2024-03-20T09:00:00.000",
    "end_time": "2024-03-20T17:00:00.000",
    "break_duration": "PT1H30M",
    "status": {
      "value": "confirmed",
      "source_value": "Confirmed"
    },
    "approval_status": {
      "value": "approved",
      "source_value": "Approved"
    },
    "breaks": [
      {
        "id": "break_123456789",
        "start_time": "2024-03-20T12:00:00Z",
        "end_time": "2024-03-20T13:00:00Z",
        "duration": "PT1H",
        "is_paid": true,
        "created_at": "2024-03-20T10:00:00Z",
        "updated_at": "2024-03-20T10:00:00Z"
      }
    ],
    "created_at": "2024-03-20T08:00:00Z",
    "updated_at": "2024-03-20T08:00:00Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy

object

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields to return in the response (if empty, all fields are returned)

Response

The shift with the given identifier was retrieved.

data

object

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employee_id

string | null

The employee ID associated with this shift

Example:

"emp_123456789"

data.location_id

string | null

The location ID where this shift takes place

Example:

"loc_123456789"

data.company_id

string | null

The company ID associated with this shift

Example:

"comp_123456789"

data.start_time

string<datetime-local> | null

The start time of the shift (ISO8601 date-time without timezone)

Example:

"2024-03-20T09:00:00.000"

data.end_time

string<datetime-local> | null

The end time of the shift (ISO8601 date-time without timezone)

Example:

"2024-03-20T17:00:00.000"

data.break_duration

string | null

The total break duration for this shift in ISO 8601 duration format

Example:

"PT1H30M"

data.status

object

The status of the shift

Show child attributes

data.status.value

enum<string> | null

The status of the shift

Available options:

draft,

published,

confirmed,

cancelled,

unmapped_value,

Example:

"confirmed"

data.status.source_value

Example:

"Confirmed"

data.approval_status

object

The approval status of the shift

Show child attributes

data.approval_status.value

enum<string> | null

The approval status of the shift

Available options:

pending,

approved,

rejected,

unmapped_value,

Example:

"approved"

data.approval_status.source_value

Example:

"Approved"

data.breaks

object[] | null

The breaks taken during this shift

Show child attributes

data.breaks.id

string | null

The unique identifier of the break

Example:

"break_123456789"

data.breaks.start_time

string<date-time> | null

The start time of the break

Example:

"2024-03-20T12:00:00Z"

data.breaks.end_time

string<date-time> | null

The end time of the break

Example:

"2024-03-20T13:00:00Z"

data.breaks.duration

string | null

The duration of the break in ISO 8601 duration format

Example:

"PT1H"

data.breaks.is_paid

Whether the break is paid

Example:

true

data.breaks.created_at

string<date-time> | null

The date and time the break was created

Example:

"2024-03-20T10:00:00Z"

data.breaks.updated_at

string<date-time> | null

The date and time the break was last updated

Example:

"2024-03-20T10:00:00Z"

data.created_at

string<date-time> | null

The date and time the shift was created

Example:

"2024-03-20T08:00:00Z"

data.updated_at

string<date-time> | null

The date and time the shift was last updated

Example:

"2024-03-20T08:00:00Z"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

List Shifts List Time Off Policies

⌘I

Getting Started

Use Cases

API Reference

Get Shift

Authorizations

Headers

Path Parameters

Query Parameters

Response