Skip to main content
GET
List equipment certificates

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter equipment certificates by ID.
  • eq(organisation,xxx): Filter equipment certificates by organisation ID.
  • eq(equipment_item,xxx): Filter equipment certificates by equipment item ID.
  • eq(equipment_certification,xxx): Filter equipment certificates by certification ID.
  • eq(risk,xxx): Filter equipment certificates by derived risk status.

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
equipment_item,
equipment_certification
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

Get a list of equipment certificates.

JSON API response object

data
A list of equipment certificates · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when an equipment certificate is returned.

An organisation