Evidal Hiring Manager API
Every Bearer-callable REST endpoint for hiring teams and their AI agents: create roles, review candidates, record decisions, and more. The interactive reference below needs JavaScript; every path is listed as plain text here too.
| Method | Path | Summary |
|---|---|---|
| PATCH | /api/v1/company/{slug} | Update company-level fields. |
| GET | /api/v1/company/{slug}/roles | List roles for the company. |
| POST | /api/v1/company/{slug}/roles/create | Create a new role. |
| GET | /api/v1/company/{slug}/roles/{roleId} | Get a single role by id or slug. |
| PATCH | /api/v1/company/{slug}/roles/{roleId} | Patch role fields. |
| POST | /api/v1/company/{slug}/roles/{roleId}/requirements/rederive | Preview a re-read of the job description (writes nothing). |
| PUT | /api/v1/company/{slug}/roles/{roleId}/requirements | Replace the requirement areas with a reviewed set. |
| POST | /api/v1/company/{slug}/roles/{roleId}/deactivate | Deactivate a role (stops accepting applications). |
| POST | /api/v1/company/{slug}/roles/{roleId}/active | Publish or unpublish a role (toggle role.active). |
| POST | /api/v1/company/{slug}/roles/{roleId}/activate-plan | Activate a role plan using a stored payment method. |
| GET | /api/v1/company/{slug}/candidates | List candidates (paginated, never includes PII). |
| GET | /api/v1/company/{slug}/candidates/{candidateAgentId} | Get a single candidate (PII-gated). |
| POST | /api/v1/company/{slug}/candidates/{candidateAgentId}/decision | Record a hiring decision for a candidate. |
| PATCH | /api/v1/company/{slug}/slack/configure | Configure Slack notification routing. |
| POST | /api/v1/company/{slug}/api-key/rotate | Rotate the company API key. |
| GET | /api/v1/company/{slug}/dns-status | Read DNS verification status for the company custom domain. |
| GET | /api/v1/company/{slug}/billing/status | Per-role and company billing state. |
| GET | /api/v1/company/{slug}/unlocks | Paginated list of $100 candidate lead unlocks. |
| POST | /api/v1/payment/stripe/checkout | Start a Stripe Checkout session for a role plan. |
| GET | /api/v1/company/{slug}/members | List hiring-team members and pending invites (paginated). |
| POST | /api/v1/company/{slug}/members/invite | Invite a teammate by email. |
| DELETE | /api/v1/company/{slug}/members/{userId} | Remove a teammate. |
| POST | /api/v1/company/{slug}/members/{userId}/role | Change a teammate's role. |
| PUT | /api/v1/company/{slug}/members/{userId}/assignments | Replace a teammate's role assignments (EVI-479). |
| DELETE | /api/v1/company/{slug}/invites/{inviteId} | Revoke a pending invite. |
| POST | /api/v1/company/onboarding/start | Start a company onboarding session. |
| GET | /api/v1/company/onboarding/{sessionId} | Poll the status of an onboarding session. |
| POST | /api/v1/company/onboarding/{sessionId} | Complete a verified onboarding session (create the company). |
| POST | /api/v1/company/onboarding/{sessionId}#cancel | Cancel an onboarding session. |
| POST | /api/v1/candidate/erase | Permanently erase all of a candidate's data (GDPR right to erasure). |
Loading interactive reference…