You are viewing an old version of the API
List workweek configs

Returns a list of WorkweekConfig instances for a business

Required permissions TIMECARDS_SETTINGS_READ

Query Parameters

Name Description
limit
integer

Maximum number of Workweek Configs to return per page.

cursor
string

Pointer to the next page of Workweek Config results to fetch.

Response Fields

Name Description
cursor
string

Value supplied in the subsequent request to fetch the next page of Employee Wage results.

errors
Error [ ]

Any errors that occurred during the request.

workweek_configs
Workweek​Config [ ]

A page of Employee Wage results.

Examples

You are viewing an old version of the API
GET /v2/labor/workweek-configs
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/labor/workweek-configs \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN'
Response JSON
{
  "workweek_configs": [
    {
      "id": "FY4VCAQN700GM",
      "start_of_week": "MON",
      "start_of_day_local_time": "10:00",
      "version": 11,
      "created_at": "2016-02-04T00:58:24Z",
      "updated_at": "2019-02-28T01:04:35Z"
    }
  ],
  "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED"
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?