Skip to main content
GET
List new hire monitors
New hire monitoring requires a V2 workspace API key. Legacy V1 API keys are not supported by these endpoints. Monitors and their credits belong to the V2 workspace associated with the key.
List every new hire monitor in the authenticated workspace, including monitors created in the Airscale app. Each monitor includes its audience, filters, status, schedule, results-table state, webhook state, company count, new hire count, and unread event count.
This operation is read-only and spends no credits. It never returns a webhook signing secret.
Monitors created in the app before role filters existed have legacy: true and filters: null. They can be read, paused, resumed, and renamed through the API, but their companies can only be edited in the app. Use the monitor id returned here with the detail, update, company, and event operations. A paused monitor stays in the list so you can resume it later. If a create request’s response was lost, list monitors before deciding whether to create another.

Next step

Open Get a new hire monitor for its companies and latest new hires.

Authorizations

Authorization
string
header
required

Use an Airscale workspace API key. Never expose the key in client-side code.

Response

The workspace monitors.

monitors
object[]
required