Skip to main content
GET
/
v2
/
shifts
/
{id}
Retrieve a shift
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/shifts/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "0183d245-b5c1-2a6d-5e37-1b831d765c5d",
  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
  "employer": "Whole Goods",
  "created_at": "2023-04-27T07:02:01.279Z",
  "updated_at": "2023-04-27T07:02:01.279Z",
  "status": "completed",
  "type": "hourly",
  "start_datetime": "2023-04-26T00:00:00Z",
  "end_datetime": "2023-04-26T08:00:00Z",
  "all_datetimes": {
    "shift_start": "2023-04-26T00:00:00Z",
    "shift_end": "2023-04-26T08:00:00Z",
    "breaks": [
      {
        "break_start": "2023-04-26T03:36:00Z",
        "break_end": "2023-04-26T04:24:00Z"
      }
    ]
  },
  "hours": "7.2",
  "timezone": "America/New_York",
  "location": "302 East N St, New York, NY 10014, US",
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Path Parameters

​
id
string<uuid>
required

ID of the shift object to be retrieved.

Response

200 - application/json
​
id
string<uuid>

Unique ID of the shift.

​
account
string<uuid>

Unique ID of the account associated with the shift.

​
employer
string

Employer name.

​
created_at
string<date-time>

Timestamp (ISO 8601) when the shift object was created.

​
updated_at
string<date-time>

Timestamp (ISO 8601) when a property value of the shift object most recently changed.

​
status
enum<string>

Current state of the shift.

Available options:
scheduled,
in_progress,
completed,
cancelled
​
type
enum<string>

The type of shift.

Available options:
hourly,
services
​
start_datetime
string<date-time>

Timestamp (ISO 8601) when the shift started.

​
end_datetime
string<date-time>

Timestamp (ISO 8601) when the shift ended.

​
all_datetimes
object

Contains information on when the shift started and ended, and any breaks taken in between.

​
hours
string

Time duration of the shift, subtracting breaks. Up to four decimal places.

​
timezone
string

Timezone (IANA) where the shift took place.

​
location
string

Full address of where the shift took place.

​
metadata
object

Additional, non-categorized information.