Skip to main content
GET
List cost kit lines

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

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter by cost kit line ID(s)
  • cost_kit: Filter by the kit the line belongs to
  • cost_item: Filter by the rate code the line names

Filter by cost_kit for everything one kit contains.

Wrap several terms in and(...), for example and(eq(cost_kit,<id>),eq(cost_item,<id>)) — a bare top-level comma silently drops the trailing terms.

For more information on using named filters, see the docs

sort
enum<string>[]

A comma separated list of fields to sort by. Sorting by created_at gives the kit's items in the order they were added, which is the order applying it writes them in.

Available options:
quantity,
-quantity,
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 kit lines.

JSON API response object

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

Related resources that can be included when a cost kit line is returned

An organisation