Get a Pay Group

get/public/v1/pay-groups/{payGroup}

Requires finance access.

get/public/v1/pay-groups/{payGroup}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/pay-groups/{payGroup}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "p1a2y3g4-r5o6-47u8-9p0a-1b2c3d4e5f6a",
    "name": "Casual Support Workers",
    "award": "schads"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

payGroupstringrequired
The pay group UUID

Response

200application/json

PayGroupResource

dataobjectrequired
▶Show 3 child attributesHide child attributes
- idstringrequired
  Example:p1a2y3g4-r5o6-47u8-9p0a-1b2c3d4e5f6a
- namestringrequired
  Example:Casual Support Workers
- awardenum<string>required
  Available options:aged_carehealth_professionalsnursesschads

Errors

401Unauthenticated
403Authorization error
404Not found