API reference
Every v1 endpoint, its scope and its parameters.
All paths are relative to https://api.interviewer.heizen.tech/api/v1. Read API basics first for authentication, errors and pagination.
| Resource | Endpoints | Scope |
|---|---|---|
| Core | GET /ping, GET /me, GET /usage | none, none, billing:read |
| Interviewers | list, retrieve | interviewers:read |
| Candidates | list, create, retrieve, update, delete | candidates:read / candidates:write |
| Invitations | list, create, bulk, retrieve, resend, extend, cancel | candidates:read / invitations:send |
| Sessions | list, retrieve, result, transcript, recording, events | results:read |
| Results | list, retrieve | results:read |
| Imports | import, list, retrieve, error file | candidates:import |
| Exports | create, list, retrieve | results:export |
| Webhook endpoints | create, list, retrieve, update, delete, rotate, deliveries, replay, test | developers:manage |
| Events | list, retrieve | developers:manage |