Skip to main content
GET
List site attendance resources

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

A comma separated list of related resources to include.

Available options:
scheme,
user,
recorded_by,
signed_out_by
sort
enum<string>[]

A comma separated list of fields to sort by.

A register reads newest-arrival-first, so -signed_in_at is the useful default for a caller to ask for; the API imposes no ordering of its own.

Available options:
attendee_name,
-attendee_name,
signed_in_at,
-signed_in_at,
signed_out_at,
-signed_out_at,
reason,
-reason,
created_at,
-created_at
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id: Filter by site attendance ID
  • scheme: Filter by scheme ID
  • user: Filter by the attendee's user account, where they hold one
  • reason: Filter by reason for attending
  • on_site: eq(on_site,true) for attendances not yet signed out. This is the evacuation list
  • signed_in_at: ge(signed_in_at,…) and le(signed_in_at,…) bound a day's register

There is no on filter: a day is expressed as a signed_in_at range like any other date window. on_site is a named filter rather than a null check on signed_out_at because the filter grammar has no null operator; it is maintained from the sign-out timestamp on write, so the two cannot disagree.

For more information on using named filters, see the docs

Response

List site attendances.

JSON API response object

data
object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a site attendance is returned

A scheme