API Reference
Log In
API Reference

Get safety inductions

Retrieve a paginated list of safety induction records.

Query Params
integer

The page number to retrieve.

integer
1 to 1000

The number of items per page. Public API clients may request up to 1000, a higher ceiling than the other Stowlog clients get.

string

Field to sort the results by. Use updatedAt together with sortOrder=asc when polling the updatedAt range for incremental reads.

string
enum

Order of sorting (asc or desc).

Allowed:
string

Identifier of the facility.

string

Email address associated with the safety induction.

string

Username to filter safety inductions.

string

Custom field key used for filtering safety inductions.

string

Custom field value used for filtering safety inductions.

string

Identifier of the user type to filter safety inductions.

inductedAt
object

Filter by the date the induction was completed or renewed, as the half-open range inductedAt[from] / inductedAt[to].

Passing a bare date string instead of the range object is deprecated and matches the whole UTC civil day that instant falls in. It is kept for backward compatibility and will be removed in a future version.

expirationDate
object

Filter by the date the induction expires, as the half-open range expirationDate[from] / expirationDate[to].

Passing a bare date string instead of the range object is deprecated and matches the whole UTC civil day that instant falls in. It is kept for backward compatibility and will be removed in a future version.

updatedAt
object

Filter by the moment the record was last modified, as the half-open range updatedAt[from] / updatedAt[to].

This is the field to poll for incremental reads: updatedAt moves on every change, including status transitions that leave inductedAt and createdAt untouched. Chain windows by using the previous window's to as the next window's from — the half-open bounds guarantee no record is returned twice and none is skipped. Combine with sortField=updatedAt and sortOrder=asc for a deterministic walk.

createdAt
object

Filter by the moment the record was created, as the half-open range createdAt[from] / createdAt[to]. Only catches new records — use updatedAt to also catch changes to existing ones.

string
enum

Current status of the safety induction.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json