Skip to main content
GET
/
analytics
/
dashboards
/
clock-ins
/
clock-ins
Get Clock Ins
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/clock-ins/clock-ins \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "providerId": "<string>",
      "providerFirstName": "<string>",
      "providerLastName": "<string>",
      "locationId": "<string>",
      "locationName": "<string>",
      "date": "2023-12-25",
      "scheduledShifts": [
        {
          "shiftId": "<string>",
          "startTime": "2023-11-07T05:31:56Z",
          "endTime": "2023-11-07T05:31:56Z",
          "title": "<string>"
        }
      ],
      "clockIns": [
        {
          "id": "<string>",
          "startTime": "2023-11-07T05:31:56Z",
          "endTime": "2023-11-07T05:31:56Z"
        }
      ],
      "totalScheduledMinutes": 123,
      "totalWorkedMinutes": 123
    }
  ],
  "total": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

start_date
string<date> | null
end_date
string<date> | null
location_ids
string[] | null
provider_ids
string[] | null
timezone
string
required
group_by
enum<string> | null
Available options:
location,
provider,
date
group_key
string | null
page
integer | null
per_page
integer | null

Response

Successful Response

data
ClockInRow · object[]
required
total
integer
required