• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

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

GET /v2/labor/workweek-configs

Returns a list of WorkweekConfig instances for a business.


Permissions
TIMECARDS_SETTINGS_READ
Try in API Explorer
Name Description
limit
integer (32-bit)

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
workweek_configs
WorkweekConfig [ ]

A page of Employee Wage results.

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.

Examples

You are viewing an old version of the API
GET /v2/labor/workweek-configs
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/labor/workweek-configs?limit=1&cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED \
  -H 'Square-Version: 2021-04-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
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?