Skip to main content
GET
List cost item versions

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,
cost_item
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter by cost item version ID(s)
  • cost_item: Filter by the cost item the version belongs to
  • version: Filter by version number
  • effective_from, effective_to: Filter on the effective window bounds
  • in_force_on: Return only the version that applied on a given date, for example eq(in_force_on,2026-03-14). Combine with cost_item to resolve the rate that applied to a job on the day the work was carried out.

For more information on using named filters, see the docs

sort
enum<string>[]

A comma separated list of fields to sort by. version is the register's own sequence for a cost item, so sorting by it gives the rate history in order.

Available options:
version,
-version,
effective_from,
-effective_from,
effective_to,
-effective_to,
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 item versions.

JSON API response object

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

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

An organisation