List Cost Codes

get/public/v1/cost-codes

Returns your organisation's cost codes, which allocate a shift's cost in payroll. Archived cost codes are returned too, carrying the date they were archived, so a code on an older support still resolves. Requires finance access.

get/public/v1/cost-codes

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

Response

{
  "data": [
    {
      "id": "c1o2s3t4-c5o6-47d8-9e0f-1a2b3c4d5e6f",
      "name": "Community Access",
      "archived_at": null
    }
  ],
  "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 cost code name.
Example:Transport
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 CostCodeResource

dataobject[]required
▶Show 3 child attributesHide child attributes
- idstringrequired
  Example:c1o2s3t4-c5o6-47d8-9e0f-1a2b3c4d5e6f
- namestringrequired
  Example:Community Access
- archived_atstring | nullrequired
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