You are viewing an old version of the API
List employee wages

Returns a paginated list of EmployeeWage instances for a business

Required permissions EMPLOYEES_READ

Query Parameters

Name Description
employee_id
string

Filter wages returned to only those that are associated with the specified employee.

limit
integer

Maximum number of Employee Wages to return per page. Can range between 1 and 200. The default is the maximum at 200.

cursor
string

Pointer to the next page of Employee Wage results to fetch.

Response Fields

Name Description
cursor
string

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

employee_wages
Employee​Wage [ ]

A 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/employee-wages
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/labor/employee-wages?employee_id=33fJchumvVdJwxV0H6L9&limit=4&cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED \
  -H 'Square-Version: 2019-12-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN'
Response JSON
{
  "employee_wages": [
    {
      "id": "pXS3qCv7BERPnEGedM4S8mhm",
      "employee_id": "33fJchumvVdJwxV0H6L9",
      "title": "Manager",
      "hourly_rate": {
        "amount": 3250,
        "currency": "USD"
      }
    },
    {
      "id": "rZduCkzYDUVL3ovh1sQgbue6",
      "employee_id": "33fJchumvVdJwxV0H6L9",
      "title": "Cook",
      "hourly_rate": {
        "amount": 2600,
        "currency": "USD"
      }
    },
    {
      "id": "FxLbs5KpPUHa8wyt5ctjubDX",
      "employee_id": "33fJchumvVdJwxV0H6L9",
      "title": "Barista",
      "hourly_rate": {
        "amount": 1600,
        "currency": "USD"
      }
    },
    {
      "id": "vD1wCgijMDR3cX5TPnu7VXto",
      "employee_id": "33fJchumvVdJwxV0H6L9",
      "title": "Cashier",
      "hourly_rate": {
        "amount": 1700,
        "currency": "USD"
      }
    }
  ],
  "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED"
}

Share Feedback

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