Retrieve wage setting

GET

/v2/team-members/{team_member_id}/wage-setting

Retrieves a WageSetting object for a team member specified by TeamMember.id.

For more information, see Troubleshooting the Team API.

Square recommends using RetrieveTeamMember or SearchTeamMembers to get this information directly from the TeamMember.wage_setting field.

Permissions:EMPLOYEES_READ

Guide

Retrieve a wage setting for a team member

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

team_member_id

string

Required

The ID of the team member for which to retrieve the wage setting.

Link to section

Response fields

Link to section

wage_setting

The successfully retrieved WageSetting object.

Link to section

errors

The errors that occurred during the request.

Link to section

Examples

All versions ->

GET /v2/team-members/{team_member_id}/wage-setting

curl https://connect.squareup.com/v2/team-members/1yJlHapkseYnNPETIU1B/wage-setting \
  -H 'Square-Version: 2024-12-18' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "wage_setting": {
    "team_member_id": "1yJlHapkseYnNPETIU1B",
    "job_assignments": [
      {
        "job_title": "Manager",
        "pay_type": "SALARY",
        "hourly_rate": {
          "amount": 2164,
          "currency": "USD"
        },
        "annual_rate": {
          "amount": 4500000,
          "currency": "USD"
        },
        "weekly_hours": 40
      }
    ],
    "is_overtime_exempt": false,
    "version": 1,
    "created_at": "2020-06-11T23:01:21+00:00",
    "updated_at": "2020-06-11T23:01:21+00:00"
  }
}