Skip to main content
GET
List cost items

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter by cost item ID(s)
  • code: Filter by rate code
  • name: Filter by name
  • category: Filter by category (material, labour, misc, contractor)
  • metering: Filter by metering type
  • unit: Filter by unit

For more information on using named filters, see the docs

sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
code,
-code,
name,
-name,
category,
-category,
metering,
-metering,
unit,
-unit,
created_at,
-created_at
limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

List of cost items.

JSON API response object

data
A list of cost items · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a cost item is returned