API Reference

Returns the enrollment status of your employees

get
https://publicapi.wagestream.io/pushapi-prod/enrollments

With this endpoint you can detect which employees have enrolled, or requested to enrol. You can then use this information to choose how/whether you send us further data

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to null

If true, will return only records which require you to perform an action on.

int32
Defaults to null

If >0, will only return a maximum number of records, ordered by requested_on asc (so, the 'oldest' records first)

int32
Defaults to 1

Enables paging through the results in conjunction with the limit parameter

boolean
≥ 0
Defaults to null

If true, will return only employees with banking details leaving only employees that have been fully enrolled.

Responses

403

Forbidden - API key required or invalid

Updated 11 months ago

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

Updated 11 months ago