List Pay Groups

get/public/v1/pay-groups

Returns your organisation's pay groups. A pay group sets the award a staff member's hours are interpreted under. Requires finance access.

get/public/v1/pay-groups

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

Response

{
  "data": [
    {
      "id": "p1a2y3g4-r5o6-47u8-9p0a-1b2c3d4e5f6a",
      "name": "Casual Support Workers",
      "award": "schads"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

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

Query parameters

filter[search]string
Partial match on the pay group name.
Example:Casual
sortstring
Sort the results. Prefix with '-' for descending. One of: name.
Example:name
page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of PayGroupResource

dataobject[]required
▶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
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error