Skip to main content
GET
List exposure days

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

Query Parameters

exposure_type
enum<string>
required

The exposure type to resolve the limit for. The type of exposure a limit applies to. havs (hand-arm vibration, in points) is the only type.

Available options:
havs
Example:

"havs"

filter
string
required

Selects the days and people. Required, because it carries the window.

  • ge(date,YYYY-MM-DD): Required. The window's first Europe/London day.
  • le(date,YYYY-MM-DD): Required. The window's last day. A window spans at most 93 days.
  • eq(subject,xxx) or in(subject,[xxx,yyy]): only these people.
  • eq(band,red) or in(band,[amber,red]): only days in these daily bands. The breach list is in(band,[amber,red]).
  • eq(weekly_band,red) or in(weekly_band,[amber,red]): only days in these weekly bands.

Terms are comma separated, or wrapped in and(...), and combine with AND. Each field other than date may appear in one term. An or(...), a repeated term, text after a term, any other term and a term that does not parse are refused with a 400 rather than ignored.

For more information on using named filters, see the docs

Minimum string length: 1
Example:

"and(ge(date,2026-11-01),le(date,2026-11-30),in(band,[amber,red]))"

limit
integer<int64>
default:100

Limit the number of resources returned by the API, at most 1000

Required range: 1 <= x <= 1000
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

Response

Get a list of exposure days.

JSON API response object

data
A list of exposure days · object[]
required
meta
object
required
jsonapi
object
required