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

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter waste submissions by ID.
  • eq(organisation,xxx): Filter waste submissions by organisation ID.
  • eq(movement,xxx): Filter submissions by the movement they belong to.
  • eq(status,xxx): Filter by submission status. One of pending, submitting, submitted, failed.
  • eq(kind,xxx): Filter by submission kind. One of receive-create, receive-amend.
  • eq(waste_tracking_id,xxx): Filter by the Digital Waste Tracking identifier.
  • ge(created_at,xxx) / le(created_at,xxx): Filter by when the submission was created. 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:
movement

Response

A list of waste submission records.

JSON API response object

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

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