Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Tip Pool

Retrieve Tip Pool Summary Report

get/v2/company/{company_id}/locations/{location_id}/tip_pool_summary_report

Path parameters

company_idinteger required

Company ID

location_idinteger required

Location ID

Query parameters

tip_pool_uuidstring uuid

The tip pool UUID, when omitted the report will return all tip pools

day_part_uuidstring uuid

Daypart UUID, when omitted the report will return all dayparts

start_datestring required

The start date in YYYY-MM-DD format

end_datestring required

The end date in YYYY-MM-DD format

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

OK

object'tip_pool_summary_report' required

Example response

{
  "data": [
    {
      "total": {
        "hours_worked": 40,
        "tip_in": 1050,
        "tip_out": 1025
      }
    }
  ]
}