Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

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
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
date_time_received,
-date_time_received,
status,
-status,
created_at,
-created_at
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter waste movements by ID.
  • eq(organisation,xxx): Filter waste movements by organisation ID.
  • eq(client_reference,xxx): Filter by the client-supplied reference (UUID).
  • eq(ewc_code,xxx): Filter to movements containing a waste item with the given EWC code.
  • eq(broker,xxx): Filter movements by linked broker catalogue record ID.
  • eq(carrier,xxx): Filter movements by linked carrier catalogue record ID.
  • eq(receiver_site,xxx): Filter movements by linked receiving site catalogue record ID.
  • ge(date_time_received,xxx) / le(date_time_received,xxx): Filter by the date received. Use the function-style ge/le operators (not gte/lte).

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
broker,
carrier,
receiver_site,
submissions

Response

A list of waste movements.

JSON API response object

data
A list of waste movements · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a waste movement is returned

A reusable broker or dealer an organisation transports waste with.