API routes
This page lists the 537 operations of the Ochema API, version 0.1.0, generated from packages/contracts/openapi.json. The web apps call them only through the client generated from that document (see API contract).
Access:
- Company session: a signed-in user with the company active; each route also checks the permission it needs.
- Platform panel session: a member of the platform team signed in to the platform panel.
- No session: a public page, a link with its own token, or a request with an API key.
Authentication
Section titled “Authentication”| Method | Path | What it does | Access |
|---|---|---|---|
| POST | /auth/forgot-password |
Request a password reset email | No session |
| POST | /auth/invitations/accept |
Accept an invitation | No session |
| POST | /auth/invitations/preview |
Company, email and role of an invitation token | No session |
| POST | /auth/login |
Sign in with email and password | No session |
| POST | /auth/logout |
Sign out (deletes the session) | Company session |
| GET | /auth/me |
Current user, active company, permissions and companies | Company session |
| PATCH | /auth/me |
Change the language of the signed-in user | Company session |
| POST | /auth/register |
Create a company and its owner, and sign in | No session |
| POST | /auth/reset-password |
Set a new password with a reset token; signs out every session | No session |
| GET | /auth/session |
Session probe: the current user, or null when nobody is signed in | No session |
| POST | /auth/switch-tenant |
Make another company of the user the active one | Company session |
| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /home |
Counts of the registers of the active company the user can read | Company session |
Search
Section titled “Search”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /search |
Search people, candidates, vehicles, customers and jobs of the active company | Company session |
Platform
Section titled “Platform”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /platform/audit-log |
Audit events of the active company, newest first | Company session |
| GET | /platform/audit-log/actors |
Users of the company as choices of the User filter (id and name) | Company session |
| GET | /platform/audit-log/export |
Export the filtered audit events as CSV | Company session |
| GET | /platform/audit-log/filters |
The actions and entities the Audit log filters offer | Company session |
| GET | /platform/company |
Details and type of operation of the active company | Company session |
| PATCH | /platform/company |
Change the details of the active company (only the fields sent) | Company session |
| GET | /platform/invitations |
Pending invitations of the active company, newest first | Company session |
| POST | /platform/invitations |
Invite a person by email; the worker sends the email | Company session |
| POST | /platform/invitations/{id}/resend |
Renew the token and validity of a pending invitation and email it again | Company session |
| POST | /platform/invitations/{id}/revoke |
Revoke a pending invitation | Company session |
| GET | /platform/lead-api-keys |
The lead intake API keys of the active company, newest first | Company session |
| POST | /platform/lead-api-keys |
Create a lead intake API key | Company session |
| POST | /platform/lead-api-keys/{id}/revoke |
Revoke a lead intake API key | Company session |
| GET | /platform/messaging-settings |
SMS number, email provider, sending options and stop texts of the active company | Company session |
| PATCH | /platform/messaging-settings |
Change the messaging options of the active company (only the fields sent) | Company session |
| POST | /platform/messaging-settings/test-email |
Send a test email to the address of the signed-in user, by the email provider in use | Company session |
| GET | /platform/messaging-settings/usage |
Messages sent and received this month and the month before, by origin | Company session |
| GET | /platform/modules |
Modules of the active company and whether each is on | Company session |
| PATCH | /platform/modules/{key} |
Turn a module on or off for the active company | Company session |
| GET | /platform/permissions |
Permission catalog, grouped by module in the interface | Company session |
| GET | /platform/roles |
Roles of the active company: system roles first, then by name | Company session |
| POST | /platform/roles |
Create a custom role | Company session |
| GET | /platform/roles/options |
Roles the caller may give when inviting a user or changing a role | Company session |
| GET | /platform/roles/{id} |
A role with its granted permissions | Company session |
| PATCH | /platform/roles/{id} |
Rename a custom role or replace its permissions | Company session |
| DELETE | /platform/roles/{id} |
Delete a custom role that nobody uses | Company session |
| GET | /platform/users |
Members of the active company, by name, keyset paginated | Company session |
| DELETE | /platform/users/{id} |
Remove a member from the active company | Company session |
| GET | /platform/users/{id}/removal-impact |
What removing a member would cancel, for the dialog to warn before | Company session |
| PATCH | /platform/users/{id}/role |
Change the role of a member | Company session |
| PATCH | /platform/users/{id}/status |
Disable or re-enable a member in the active company | Company session |
| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /files/{fileId} |
Content of a file the user may read | Company session |
Signing
Section titled “Signing”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /signing/envelopes/{envelopeId}/session |
What a user of the company who signs an envelope sees: document, signers and state | Company session |
| GET | /signing/envelopes/{envelopeId}/session/document |
The PDF of the envelope the user of the session signs | Company session |
| POST | /signing/envelopes/{envelopeId}/session/sign |
The user of the session signs the envelope with the full name typed | Company session |
Attract
Section titled “Attract”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /attract/access |
Checks that the Attract module is on and the caller may open it | Company session |
| GET | /attract/analytics/channels |
Leads, qualified and hired by channel and by campaign, with the lead to hire rate | Company session |
| GET | /attract/analytics/leads-by-day |
Leads by day of the period, by channel | Company session |
| GET | /attract/analytics/recovered-applications |
Drafts reminded to finish the application, and how many applied after it | Company session |
| GET | /attract/analytics/tracked-links |
Clicks, started and submitted applications per tracked link, with the completion rate | Company session |
| GET | /attract/broadcasts |
Broadcasts of the active company, newest first, with sent and replies | Company session |
| POST | /attract/broadcasts |
Create a broadcast as a draft: the smart list, the channel and the template | Company session |
| GET | /attract/broadcasts/{id} |
A broadcast with the numbers of its audience and its result | Company session |
| PATCH | /attract/broadcasts/{id} |
Edit a draft | Company session |
| POST | /attract/broadcasts/{id}/cancel |
“Cancel” a scheduled, sending or paused broadcast | Company session |
| POST | /attract/broadcasts/{id}/pause |
“Pause”: no more recipients are handed to the sending service | Company session |
| GET | /attract/broadcasts/{id}/recipients |
The recipients of a broadcast with the status of each one | Company session |
| POST | /attract/broadcasts/{id}/resume |
“Resume” a paused broadcast from the recipient it stopped at | Company session |
| GET | /attract/broadcasts/{id}/review |
Step “Review” of a draft: who receives, who is left out and why, segments and cost | Company session |
| POST | /attract/broadcasts/{id}/schedule |
“Schedule”: send at a date and time | Company session |
| POST | /attract/broadcasts/{id}/send |
“Send now”: copy the audience and start the send | Company session |
| GET | /attract/campaigns |
Campaigns of the active company: search by name, filter by status and channel | Company session |
| POST | /attract/campaigns |
Create a campaign | Company session |
| GET | /attract/campaigns/{id} |
A campaign with its destination and whether its links are in force today | Company session |
| PATCH | /attract/campaigns/{id} |
Change a campaign (only the fields sent) | Company session |
| POST | /attract/campaigns/{id}/archive |
Archive a campaign (its links lead to the careers page; nothing is deleted) | Company session |
| GET | /attract/campaigns/{id}/leads |
Applications credited to a campaign, newest first, with stage and status | Company session |
| GET | /attract/campaigns/{id}/links |
Tracked links of a campaign, active first, with clicks and leads | Company session |
| POST | /attract/campaigns/{id}/links |
Create a tracked link of a campaign, with a short code unique in the platform | Company session |
| PATCH | /attract/campaigns/{id}/links/{linkId} |
Change a tracked link (only the fields sent; the code never changes) | Company session |
| POST | /attract/campaigns/{id}/links/{linkId}/archive |
Archive a tracked link (its short link leads to the careers page) | Company session |
| POST | /attract/campaigns/{id}/links/{linkId}/reactivate |
Reactivate an archived tracked link | Company session |
| POST | /attract/campaigns/{id}/reactivate |
Reactivate an archived campaign | Company session |
| GET | /attract/careers-site |
Settings of the careers page of the active company | Company session |
| PATCH | /attract/careers-site |
Change the careers page of the active company (only the fields sent) | Company session |
| PUT | /attract/careers-site/logo |
Send the logo of the careers page (replaces the current one) | Company session |
| DELETE | /attract/careers-site/logo |
Remove the logo of the careers page | Company session |
| GET | /attract/jobs |
Jobs of the active company: search by title, filter by status, driver type, route type, terminal and state served | Company session |
| POST | /attract/jobs |
Create a job | Company session |
| GET | /attract/jobs/options |
Open and paused jobs as choices (id, title, status) for the candidate form | Company session |
| GET | /attract/jobs/{id} |
A job with its terminal, pay and requirements | Company session |
| PATCH | /attract/jobs/{id} |
Change a job (only the fields sent) | Company session |
| POST | /attract/jobs/{id}/archive |
Archive a job (it leaves the lists; nothing is deleted) | Company session |
| GET | /attract/jobs/{id}/candidates |
Candidates who applied to a job, newest application first | Company session |
| POST | /attract/jobs/{id}/reactivate |
Reactivate an archived job | Company session |
| GET | /attract/jobs/{id}/screening-questions |
Screening questions of a job, in the order the applicant sees them | Company session |
| PUT | /attract/jobs/{id}/screening-questions |
Save the screening questions of a job: the whole list, in order | Company session |
| GET | /attract/jobs/{id}/screening-questions/standard |
The standard screening questions built from the job requirements (not saved) | Company session |
| GET | /attract/jobs/{id}/tracked-links |
Active tracked links that lead to a job (Share tab; created in Attract > Campaigns) | Company session |
| GET | /attract/leads |
Leads (applications) by arrival, newest first, by cursor | Company session |
| GET | /attract/leads/campaign-options |
The campaigns of the company as choices of the campaign filter and of the condition of an automation rule | Company session |
| GET | /attract/leads/counts |
Leads that arrived today, in the last 7 days and in the last 30 days | Company session |
| GET | /attract/leads/duplicates |
The open items of the Duplicates queue, newest first, by cursor | Company session |
| GET | /attract/leads/duplicates/count |
How many items are open in the Duplicates queue, up to 1,000 | Company session |
| GET | /attract/referrals |
Referrals of the active company, newest first: search by name, filter by status | Company session |
| POST | /attract/referrals |
Add a referral made outside the referral link, for an existing application | Company session |
| GET | /attract/referrals/application-options |
Applications without a referral, of candidates not archived, for “Add referral” | Company session |
| GET | /attract/referrals/people/{personId}/link |
The referral link of a person, if any, and the program settings | Company session |
| POST | /attract/referrals/people/{personId}/link |
Create the referral link of a person (one per person; answers the existing one) | Company session |
| GET | /attract/referrals/person-options |
People who can refer (not archived), for “Add referral” | Company session |
| GET | /attract/referrals/program |
The referral program settings (off while never saved) | Company session |
| PUT | /attract/referrals/program |
Save the referral program settings: on or off, default bonus and payout rule | Company session |
| GET | /attract/referrals/{id} |
A referral with its application, bonus and the history of its decisions | Company session |
| POST | /attract/referrals/{id}/approve |
Approve the bonus of an eligible referral | Company session |
| POST | /attract/referrals/{id}/pay |
Mark the bonus of an approved referral as paid (a record only; no payment is made) | Company session |
| POST | /attract/referrals/{id}/reject |
Reject a referral that is pending, eligible or approved | Company session |
Recruit
Section titled “Recruit”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /recruit/access |
Checks that the Recruit module is on and the caller may open it | Company session |
| GET | /recruit/analytics/communication/first-contact |
Speed to first contact: seconds from the application to its first SMS | Company session |
| GET | /recruit/analytics/communication/interviews |
Interviews: booked, completed, no-shows, canceled, attendance and self-booked share | Company session |
| GET | /recruit/analytics/communication/recruiters |
By recruiter: messages by hand, answer time in working hours, interviews and scorecards | Company session |
| GET | /recruit/analytics/communication/reply-rate |
Reply rate: first-contact SMS answered within 48 hours, by source channel | Company session |
| GET | /recruit/analytics/communication/templates |
Templates: sent, delivered, replies within 48 hours and requests to stop, by template | Company session |
| GET | /recruit/analytics/funnel |
Funnel: how many applications created in the period reached each stage | Company session |
| GET | /recruit/analytics/reasons |
Reasons: not qualified and withdrawn applications created in the period, by reason | Company session |
| GET | /recruit/analytics/recruiters |
Recruiters: active applications, stage moves, calls, notes, tasks, hires and first contact | Company session |
| GET | /recruit/analytics/time |
Time: days to hire (median and 90th percentile) and median days in each stage | Company session |
| POST | /recruit/applications/move |
Move up to 200 applications to one open stage, with a result for each | Company session |
| GET | /recruit/applications/{id}/first-response |
The first SMS of one application and the seconds it took (“First response in 12 s”) | Company session |
| GET | /recruit/applications/{id}/full-application |
The full application of an application: its link, what the candidate filled in by section and what is missing | Company session |
| POST | /recruit/applications/{id}/full-application/cancel-link |
“Cancel link”: the page of the candidate answers “This link is no longer valid” | Company session |
| POST | /recruit/applications/{id}/full-application/link |
“Copy link”: a new link of the full application, shown once | Company session |
| POST | /recruit/applications/{id}/full-application/request-changes |
“Request changes”: reopens a signed full application for the candidate, with a note | Company session |
| POST | /recruit/applications/{id}/full-application/reveal |
“Reveal”: the whole Social Security number, date of birth or license number | Company session |
| POST | /recruit/applications/{id}/full-application/send |
“Send full application” and “Resend”: a new link, sent to the candidate by email or SMS | Company session |
| GET | /recruit/applications/{id}/full-application/signed-pdf |
The signed PDF of the full application, with the proof of the signature | Company session |
| GET | /recruit/applications/{id}/hire |
What the dialog “Hire candidate” shows: the data of the candidate that goes to the person and the people found with the same email or phone | Company session |
| POST | /recruit/applications/{id}/hire |
Hire: create or link the person in People > Directory and move the application to Hired, in one transaction | Company session |
| GET | /recruit/applications/{id}/hiring |
The hire of an application: the person of the candidate and until when the hire can be undone | Company session |
| POST | /recruit/applications/{id}/move |
Move an active application to another open stage | Company session |
| POST | /recruit/applications/{id}/not-qualified |
Mark an active application Not qualified, with a reason | Company session |
| GET | /recruit/applications/{id}/offers |
The offer of an application and the ones before it | Company session |
| POST | /recruit/applications/{id}/offers |
“Send offer”: creates the offer and the document the candidate signs by link | Company session |
| POST | /recruit/applications/{id}/offers/preview |
The text of an offer as the candidate would read it, before sending | Company session |
| POST | /recruit/applications/{id}/reopen |
Reopen a closed application | Company session |
| GET | /recruit/applications/{id}/score |
The score of one application (rules-1, a fit score) with the points of each criterion | Company session |
| POST | /recruit/applications/{id}/undo-hire |
Undo hire, for 7 days: the application returns to the stage it was in and the person the hire created is archived | Company session |
| POST | /recruit/applications/{id}/withdraw |
Record that the candidate withdrew, with a reason | Company session |
| GET | /recruit/automations/rules |
Automation rules of the active company, with their runs of the last 7 days | Company session |
| POST | /recruit/automations/rules |
Create an automation rule, turned off | Company session |
| GET | /recruit/automations/rules/catalog |
The triggers, the condition fields and the actions a rule of Recruit can use | Company session |
| POST | /recruit/automations/rules/test-run |
Evaluate a rule, saved or not, against one application, without running it | Company session |
| GET | /recruit/automations/rules/{id} |
One automation rule, with its trigger, its conditions and its actions in order | Company session |
| PATCH | /recruit/automations/rules/{id} |
Edit an automation rule | Company session |
| POST | /recruit/automations/rules/{id}/archive |
Archive a rule: it is turned off and its pending actions are canceled | Company session |
| POST | /recruit/automations/rules/{id}/disable |
Turn a rule off and cancel its pending actions | Company session |
| POST | /recruit/automations/rules/{id}/enable |
Turn a rule on | Company session |
| POST | /recruit/automations/rules/{id}/reactivate |
Reactivate an archived rule. It comes back turned off | Company session |
| GET | /recruit/automations/rules/{id}/runs |
Run history of a rule: each run with its actions and their results, newest first | Company session |
| GET | /recruit/board |
The columns of the board in pipeline order, Not qualified last, each with the count of its cards; filter by job, recruiter and source | Company session |
| GET | /recruit/board/columns/{stageId}/cards |
The cards (applications) of one column, by cursor: who entered the stage longest ago first, or by score; the final columns show the last 30 days, newest first | Company session |
| GET | /recruit/calendar-connection |
The user’s connected calendar and the providers that can be connected | Company session |
| DELETE | /recruit/calendar-connection |
Disconnect the user’s calendar | Company session |
| PUT | /recruit/calendar-connection/calendar |
Choose which calendar of the account receives the interviews | Company session |
| GET | /recruit/calendar-connection/calendars |
The calendars of the connected account that can receive interviews | Company session |
| POST | /recruit/calendar-connection/connect |
Start connecting a calendar: the address of the provider to sign in | Company session |
| POST | /recruit/calendar-connection/oauth/complete |
Finish connecting a calendar with what the provider sent back | Company session |
| POST | /recruit/calendar-connection/sync |
Sync now: ask for a read of the busy times of the connected calendar | Company session |
| GET | /recruit/call-list |
Today’s call list of the caller and the progress of the day | Company session |
| POST | /recruit/call-list/calls |
Record the outcome of a call to a candidate | Company session |
| POST | /recruit/candidate-merges |
Merge two candidates: one stays, the other is archived pointing at it | Company session |
| GET | /recruit/candidate-merges/preview |
Two candidates side by side, before merging them by hand | Company session |
| GET | /recruit/candidates |
Candidates of the active company with their current application: search by name, email or phone; filter by CDL class, endorsement, state, stage, source and recruiter | Company session |
| POST | /recruit/candidates |
Create a candidate and its application (job of interest and stage) | Company session |
| POST | /recruit/candidates/duplicates |
Candidates (archived included) that already have this email or phone, for the warning of the create form | Company session |
| GET | /recruit/candidates/{id} |
A candidate with the current application (job of interest, stage, status) | Company session |
| PATCH | /recruit/candidates/{id} |
Change a candidate and the job or stage of its current application (only the fields sent) | Company session |
| GET | /recruit/candidates/{id}/applications |
Every application of the candidate, active and closed, newest first | Company session |
| POST | /recruit/candidates/{id}/applications |
Add an application of the candidate to another job, or a general one | Company session |
| GET | /recruit/candidates/{id}/applications/{applicationId} |
One application: stage history, screening answers and the full origin | Company session |
| POST | /recruit/candidates/{id}/archive |
Archive a candidate (it leaves the lists; nothing is deleted) | Company session |
| GET | /recruit/candidates/{id}/consents |
Consents of the candidate: the current state of each channel and every row, newest first | Company session |
| POST | /recruit/candidates/{id}/consents |
Record a consent or an opt-out by hand: a new row, the one before is kept | Company session |
| GET | /recruit/candidates/{id}/identifiers |
Secondary emails and phones of the candidate (“Also known by”): from merges, from changes of the main value and from leads without a session (unverified_intake: a contact a public form or the lead API brought for a candidate that had none, not written on the profile) |
Company session |
| DELETE | /recruit/candidates/{id}/identifiers/{identifierId} |
Remove a secondary email or phone: it stops finding the candidate | Company session |
| POST | /recruit/candidates/{id}/identifiers/{identifierId}/make-primary |
Make a secondary email or phone the main one of the candidate | Company session |
| GET | /recruit/candidates/{id}/interviews |
The interviews of a candidate, by application, with their scorecards | Company session |
| POST | /recruit/candidates/{id}/notes |
Add a note (plain text, up to 5,000 characters) to the candidate | Company session |
| PATCH | /recruit/candidates/{id}/notes/{noteId} |
Change a note: only its author, within 24 hours of writing it (403 otherwise) | Company session |
| DELETE | /recruit/candidates/{id}/notes/{noteId} |
Delete a note: only its author, within 24 hours of writing it (403 otherwise) | Company session |
| POST | /recruit/candidates/{id}/portal-link |
“Copy portal link”: a new link of the area of the candidate, shown once | Company session |
| POST | /recruit/candidates/{id}/reactivate |
Reactivate an archived candidate (a returning lead) | Company session |
| GET | /recruit/candidates/{id}/screening-answers |
Sets of screening answers of each application of the candidate, in order, with their dates and what changed from one set to the next | Company session |
| GET | /recruit/candidates/{id}/sequence-enrollments |
The sequences a candidate is in now, with the step and the next sending | Company session |
| GET | /recruit/candidates/{id}/tasks |
The tasks linked to a candidate, newest first, every status, at most 100 | Company session |
| GET | /recruit/candidates/{id}/timeline |
Events of the candidate, newest first, 50 a page: applications created, stage changes, notes, calls, consents, finished tasks and the events of the candidate (recruiter change, merge, identifiers) | Company session |
| GET | /recruit/distribution |
The lead distribution rules of the active company, in order, and the recruiter limits | Company session |
| PUT | /recruit/distribution |
Replace the lead distribution rules and the recruiter limits | Company session |
| GET | /recruit/imports |
Import history of the active company, newest first | Company session |
| POST | /recruit/imports |
Step 1: upload a CSV or XLSX file of candidates | Company session |
| GET | /recruit/imports/fields |
The fields a column of the file can be linked to, and the limits | Company session |
| GET | /recruit/imports/template |
The template (“Download template”): a CSV with the expected columns | Company session |
| GET | /recruit/imports/{id} |
One import: status, mapping, options, counts of the validation and progress | Company session |
| POST | /recruit/imports/{id}/cancel |
Cancel an import; the rows already imported stay | Company session |
| GET | /recruit/imports/{id}/error-file |
Download the error file: the rows refused, with the row number and the reason | Company session |
| PUT | /recruit/imports/{id}/mapping |
Step 2: save the mapping and the options, and check every row | Company session |
| GET | /recruit/imports/{id}/preview |
Step 3: how many rows create, fall on an existing candidate or have an error | Company session |
| POST | /recruit/imports/{id}/start |
Step 4: import the rows (in the worker); a failed import continues where it stopped | Company session |
| GET | /recruit/inbox/by-candidate/{candidateId} |
The SMS and email conversations of a candidate and what the reply box needs | Company session |
| GET | /recruit/inbox/by-candidate/{candidateId}/contact-status |
SMS consent and email suppression of a candidate (labels of the candidate page) | Company session |
| GET | /recruit/inbox/by-candidate/{candidateId}/messages |
Messages of a candidate in one channel, newest first, 50 per page by cursor | Company session |
| GET | /recruit/inbox/conversations |
Conversations of the inbox: unread first, then the most recent | Company session |
| GET | /recruit/inbox/conversations/{id} |
Header of a conversation: candidate, stage, consent and what the composer needs | Company session |
| POST | /recruit/inbox/conversations/{id}/assign |
Assign a conversation | Company session |
| POST | /recruit/inbox/conversations/{id}/dismiss |
“Dismiss” an “Unknown sender” conversation | Company session |
| POST | /recruit/inbox/conversations/{id}/done |
“Mark as done” | Company session |
| POST | /recruit/inbox/conversations/{id}/link |
“Link to a candidate” of an “Unknown sender” conversation | Company session |
| GET | /recruit/inbox/conversations/{id}/messages |
Messages of a conversation, newest first, 50 per page by cursor | Company session |
| POST | /recruit/inbox/conversations/{id}/read |
Mark a conversation as read (opening it) | Company session |
| POST | /recruit/inbox/conversations/{id}/reopen |
“Reopen” | Company session |
| POST | /recruit/inbox/conversations/{id}/unread |
“Mark as unread” | Company session |
| POST | /recruit/inbox/messages |
Send an SMS or an email typed by hand, or a template, to a candidate | Company session |
| POST | /recruit/inbox/template-preview |
A template filled for a candidate, as a message sent by hand would leave | Company session |
| GET | /recruit/inbox/unread |
Open conversations of the caller with unread messages (menu and Home counter) | Company session |
| GET | /recruit/interview-settings/reminders |
When the interview reminders leave and how long a waiting list offer stays open | Company session |
| PUT | /recruit/interview-settings/reminders |
Save the times of the interview reminders and of the waiting list offer | Company session |
| GET | /recruit/interview-types |
Interview types of the active company: search by name, filter by how it happens | Company session |
| POST | /recruit/interview-types |
Create an interview type | Company session |
| GET | /recruit/interview-types/options |
Active interview types as choices, with the recruiters of each | Company session |
| GET | /recruit/interview-types/{id} |
An interview type with its recruiters | Company session |
| PATCH | /recruit/interview-types/{id} |
Change an interview type (only the fields sent) | Company session |
| POST | /recruit/interview-types/{id}/archive |
Archive an interview type: no new link or booking; scheduled interviews stay | Company session |
| POST | /recruit/interview-types/{id}/reactivate |
Reactivate an archived interview type | Company session |
| GET | /recruit/interview-waitlist |
The open waiting list entries of an application | Company session |
| POST | /recruit/interview-waitlist |
“Add to waiting list”: wait for a freed time of an interview type | Company session |
| DELETE | /recruit/interview-waitlist/{id} |
“Remove from waiting list” | Company session |
| GET | /recruit/interviews |
The interviews of a range (up to 42 days) and the tasks with a due time | Company session |
| POST | /recruit/interviews |
“Pick a time now”: book an interview at one of the free times | Company session |
| GET | /recruit/interviews/availability |
The weekly hours, upcoming time off and time zone of a recruiter | Company session |
| PUT | /recruit/interviews/availability |
Save the time zone and the weekly hours of a recruiter (the whole week) | Company session |
| POST | /recruit/interviews/availability/calendar-feed/reset |
Make a new address for the user’s calendar feed (.ics) | Company session |
| POST | /recruit/interviews/availability/time-off |
Add time off: block an interval of one date (0 to 1440 is the whole day) | Company session |
| DELETE | /recruit/interviews/availability/time-off/{id} |
Remove a time off | Company session |
| POST | /recruit/interviews/scheduling-links |
“Send scheduling link”: make a link and send it with the invitation template | Company session |
| GET | /recruit/interviews/{id} |
One interview, for its panel | Company session |
| POST | /recruit/interviews/{id}/cancel |
“Cancel” an interview; its time is offered to the waiting list | Company session |
| POST | /recruit/interviews/{id}/complete |
“Mark completed” | Company session |
| POST | /recruit/interviews/{id}/no-show |
“Mark no-show” | Company session |
| POST | /recruit/interviews/{id}/reschedule |
“Reschedule”: move the interview to another free time | Company session |
| GET | /recruit/interviews/{id}/scorecard |
The scorecard of an interview, or the empty one the first save would start | Company session |
| PUT | /recruit/interviews/{id}/scorecard |
“Save draft” and “Submit” the scorecard of an interview | Company session |
| POST | /recruit/merge-reviews/{id}/keep-separate |
Keep the two candidates of a Duplicates item separate | Company session |
| GET | /recruit/message-templates |
Message templates of the active company: search by name, filter by channel and stage | Company session |
| POST | /recruit/message-templates |
Create a message template | Company session |
| GET | /recruit/message-templates/options |
Active templates as choices for the inbox, the candidate record, rules, sequences and broadcasts | Company session |
| POST | /recruit/message-templates/preview |
Render the texts of a template for a candidate, in English and in Spanish | Company session |
| GET | /recruit/message-templates/{id} |
A message template with both texts | Company session |
| PATCH | /recruit/message-templates/{id} |
Change a message template (only the fields sent) | Company session |
| POST | /recruit/message-templates/{id}/archive |
Archive a message template (a system template is never archived) | Company session |
| POST | /recruit/message-templates/{id}/reactivate |
Reactivate an archived message template | Company session |
| POST | /recruit/message-templates/{id}/restore-default |
Restore the original subject and body of a system template | Company session |
| GET | /recruit/offer-templates |
Offer templates of the active company: search by name, filter by employment type | Company session |
| POST | /recruit/offer-templates |
Create an offer template | Company session |
| GET | /recruit/offer-templates/options |
Active offer templates as choices for “Send offer” | Company session |
| GET | /recruit/offer-templates/{id} |
An offer template with both bodies | Company session |
| PATCH | /recruit/offer-templates/{id} |
Change an offer template (only the fields sent) | Company session |
| POST | /recruit/offer-templates/{id}/archive |
Archive an offer template | Company session |
| POST | /recruit/offer-templates/{id}/reactivate |
Reactivate an archived offer template | Company session |
| POST | /recruit/offers/labels |
The offer label of the cards of the board (“Offer sent”, “Offer accepted”) | Company session |
| POST | /recruit/offers/{id}/link |
“Copy link”: a new link to the page where the candidate answers the offer | Company session |
| GET | /recruit/offers/{id}/signed-pdf |
The signed offer, with its signature certificate (PDF) | Company session |
| POST | /recruit/offers/{id}/withdraw |
“Withdraw”: cancels the offer before the candidate signs it | Company session |
| GET | /recruit/pipeline-stages |
The pipeline stages of the active company: active ones in order, then archived | Company session |
| POST | /recruit/pipeline-stages |
Add a stage at the end of the pipeline | Company session |
| GET | /recruit/pipeline-stages/options |
Active pipeline stages in order (id, name, color, kind) for the candidate form | Company session |
| PUT | /recruit/pipeline-stages/order |
Reorder the pipeline: every active stage once, in the new order | Company session |
| PATCH | /recruit/pipeline-stages/{id} |
Rename, recolor or change the kind of a stage (only the fields sent) | Company session |
| POST | /recruit/pipeline-stages/{id}/archive |
Archive a stage without applications (never the Hired stage, the system Not qualified stage nor the only stage in progress) | Company session |
| POST | /recruit/pipeline-stages/{id}/reactivate |
Reactivate an archived stage as the last stage of the pipeline | Company session |
| GET | /recruit/reasons |
The reasons of the active company: active ones by list and position, then archived | Company session |
| POST | /recruit/reasons |
Add a reason of the company to the Not qualified or the Withdrawn list | Company session |
| PATCH | /recruit/reasons/{id} |
Rename a reason the company created | Company session |
| POST | /recruit/reasons/{id}/archive |
Archive a reason: it is no longer a choice, and the applications closed with it keep it | Company session |
| POST | /recruit/recruiter-assignments |
Change the recruiter of up to 200 candidates | Company session |
| GET | /recruit/recruiters/options |
Active members as recruiter choices (user id and name, never the email) | Company session |
| GET | /recruit/scheduling/slots |
The free times of an interview type in the next 14 days, in UTC | Company session |
| GET | /recruit/scorecard-templates |
Scorecard templates of the active company: search by name | Company session |
| POST | /recruit/scorecard-templates |
Create a scorecard template | Company session |
| GET | /recruit/scorecard-templates/{id} |
A scorecard template with its criteria and jobs | Company session |
| PATCH | /recruit/scorecard-templates/{id} |
Change a scorecard template (only the fields sent) | Company session |
| POST | /recruit/scorecard-templates/{id}/archive |
Archive a scorecard template: no new scorecard starts from it | Company session |
| POST | /recruit/scorecard-templates/{id}/reactivate |
Reactivate an archived scorecard template | Company session |
| GET | /recruit/sequences |
Sequences of the active company with their enrolled now, completed and exited by reply | Company session |
| POST | /recruit/sequences |
Create a sequence with its steps | Company session |
| GET | /recruit/sequences/options |
Active sequences as choices for “Add to sequence” and for the action of a rule | Company session |
| GET | /recruit/sequences/{id} |
A sequence with its steps in order, its exit conditions and its counts | Company session |
| PATCH | /recruit/sequences/{id} |
Edit a sequence: its name, its exit conditions or its steps | Company session |
| POST | /recruit/sequences/{id}/archive |
Archive a sequence: every enrollment in course ends as sequence_archived |
Company session |
| GET | /recruit/sequences/{id}/enrollments |
The enrolled of a sequence in one status, newest first | Company session |
| POST | /recruit/sequences/{id}/enrollments |
“Add to sequence”: enroll one candidate | Company session |
| POST | /recruit/sequences/{id}/enrollments/bulk |
Enroll a batch from Recruit > Candidates: a smart list or the rows picked | Company session |
| POST | /recruit/sequences/{id}/enrollments/{enrollmentId}/remove |
“Remove”: take one candidate out of the sequence | Company session |
| POST | /recruit/sequences/{id}/pause |
Pause a sequence: no step of it is sent until it is resumed | Company session |
| POST | /recruit/sequences/{id}/reactivate |
Reactivate an archived sequence. The enrollments it ended stay ended | Company session |
| POST | /recruit/sequences/{id}/resume |
Resume a paused sequence from the step each candidate was at | Company session |
| GET | /recruit/smart-lists |
The smart lists of the caller and the shared smart lists of the company, by name | Company session |
| POST | /recruit/smart-lists |
Save the search, sort and filters of Recruit > Candidates as a smart list | Company session |
| PATCH | /recruit/smart-lists/{id} |
Rename a smart list, change its filters or who sees it | Company session |
| DELETE | /recruit/smart-lists/{id} |
Delete a smart list: the candidates stay, only the saved filters go | Company session |
| GET | /recruit/tasks |
“My tasks”: the open tasks of one user in Overdue, Today, Upcoming and no due date | Company session |
| POST | /recruit/tasks |
Add a task, for the caller or (with recruit.tasks.read_team) for another member | Company session |
| GET | /recruit/tasks/summary |
The open tasks of the caller due today and overdue (Home and menu counter) | Company session |
| PATCH | /recruit/tasks/{id} |
Complete, reopen, cancel, reassign or change a task | Company session |
Compliance
Section titled “Compliance”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /compliance/access |
Checks that the Compliance module is on and the caller may open it | Company session |
| GET | /compliance/alert-settings |
The alert milestones and who receives the alerts of the company | Company session |
| PATCH | /compliance/alert-settings |
Change the alert milestones, the “expiring” window or the recipients | Company session |
| GET | /compliance/alert-settings/recipient-options |
Active members of the company who can receive the alerts | Company session |
| GET | /compliance/audit-export/candidates |
“Choose a driver”: the open driver files of the company, by name | Company session |
| GET | /compliance/audit-export/exports |
The 50 latest exports of the company, newest first | Company session |
| POST | /compliance/audit-export/exports |
“Generate export”: one driver, a selection or a filter | Company session |
| GET | /compliance/audit-export/exports/{id} |
One export, with its progress | Company session |
| GET | /compliance/audit-export/exports/{id}/file |
The file of a completed export, for 7 days after it was made | Company session |
| GET | /compliance/audit-export/retention |
The terminated driver files, or “Retention ended” (view=ended) |
Company session |
| POST | /compliance/audit-export/retention/{driverFileId}/keep |
“Keep”: a reason and a later end of retention | Company session |
| POST | /compliance/audit-export/retention/{driverFileId}/mark-for-deletion |
“Mark for deletion”: the name of the person typed again; only marks | Company session |
| POST | /compliance/audit-export/retention/{driverFileId}/termination-date |
Corrects the date of termination; the end of retention is counted again | Company session |
| GET | /compliance/contract-documents/driver-files/{driverFileId} |
Contracts and forms of a driver file: the documents sent, the admission packet of its employment type, and the contract of another employment type | Company session |
| POST | /compliance/contract-documents/driver-files/{driverFileId}/send |
“Send admission packet”: one document to sign per template, in the order given | Company session |
| POST | /compliance/contract-documents/{id}/cancel |
Cancel a document waiting for a signature; it stays in the driver file, canceled | Company session |
| GET | /compliance/contract-documents/{id}/signed-pdf |
The completed document, with its signature certificate (PDF) | Company session |
| GET | /compliance/contract-templates |
Contract templates of the active company: search by name, filter by type and employment type | Company session |
| POST | /compliance/contract-templates |
Create a contract template | Company session |
| GET | /compliance/contract-templates/document-type-choices |
Active document types, for the item a completed document approves | Company session |
| GET | /compliance/contract-templates/options |
Active contract templates as choices for “Send admission packet” | Company session |
| GET | /compliance/contract-templates/{id} |
A contract template with both bodies and its form fields | Company session |
| PATCH | /compliance/contract-templates/{id} |
Change a contract template (only the fields sent) | Company session |
| POST | /compliance/contract-templates/{id}/archive |
Archive a contract template | Company session |
| POST | /compliance/contract-templates/{id}/reactivate |
Reactivate an archived contract template | Company session |
| GET | /compliance/document-types |
Catalog rules for the company type of operation, then own document types: search by name and filters | Company session |
| POST | /compliance/document-types |
Create an own document type | Company session |
| GET | /compliance/document-types/rules/{id} |
A catalog rule (read only) with the company switch | Company session |
| PATCH | /compliance/document-types/rules/{id} |
Turn an optional catalog rule off or back on for the company | Company session |
| GET | /compliance/document-types/{id} |
An own document type of the company | Company session |
| PATCH | /compliance/document-types/{id} |
Change an own document type (only the fields sent) | Company session |
| POST | /compliance/document-types/{id}/archive |
Archive an own document type (it leaves the list; nothing is deleted) | Company session |
| POST | /compliance/document-types/{id}/reactivate |
Reactivate an archived own document type | Company session |
| GET | /compliance/driver-files |
Driver files of the company by name: overall status, eligibility, items missing and next expiration | Company session |
| GET | /compliance/driver-files/applications/{applicationId} |
The driver file of an application in hiring (or of the person it hired) | Company session |
| POST | /compliance/driver-files/items/{itemId}/approve |
“Approve” with the expiration date | Company session |
| GET | /compliance/driver-files/items/{itemId}/files |
The files of an item, the one in force and the previous ones, newest first | Company session |
| POST | /compliance/driver-files/items/{itemId}/files |
“Upload”: a document for the item (multipart, field file, optional field side) |
Company session |
| GET | /compliance/driver-files/items/{itemId}/history |
The history of an item (C33): every step in order, with its author and date | Company session |
| POST | /compliance/driver-files/items/{itemId}/reject |
“Send back” with the reason the driver reads (1 to 500 characters) | Company session |
| POST | /compliance/driver-files/items/{itemId}/reopen |
“Reopen”: an approval, a rejection or a waiver undone; the item is missing again | Company session |
| POST | /compliance/driver-files/items/{itemId}/waive |
“Waive” with the reason (1 to 500 characters) | Company session |
| GET | /compliance/driver-files/people/{personId} |
The driver file of a person, with its items in the order of the catalog | Company session |
| GET | /compliance/driver-files/review-next |
“Review next”: the oldest item waiting for review, of the driver file given and then of the company | Company session |
| GET | /compliance/driver-files/{driverFileId} |
A driver file by its id, with its items | Company session |
| POST | /compliance/driver-files/{driverFileId}/driver-type |
“Change type”: CDL, non-CDL or owner-operator (C01) | Company session |
| GET | /compliance/drug-alcohol |
People with a record in the drug and alcohol file, by name | Company session |
| GET | /compliance/drug-alcohol/access-log |
Who read the drug and alcohol file: of one person, or the last 200 reads | Company session |
| GET | /compliance/drug-alcohol/applications/{applicationId} |
The drug and alcohol file of a candidate not hired yet, by application | Company session |
| GET | /compliance/drug-alcohol/people/{personId} |
The drug and alcohol file of one person: every record, by type | Company session |
| POST | /compliance/drug-alcohol/records |
Record a test, a query, a consent or another document, without a file | Company session |
| POST | /compliance/drug-alcohol/records/with-file |
Record a test, a query, a consent or another document, with its file | Company session |
| GET | /compliance/drug-alcohol/records/{id} |
One record, with the answers of the previous employer when it is a reply of one | Company session |
| GET | /compliance/drug-alcohol/records/{id}/file |
The file attached to a record | Company session |
| PATCH | /compliance/drug-alcohol/records/{id}/not-cleared |
Set or remove the mark “Not cleared for safety-sensitive work” | Company session |
| POST | /compliance/drug-alcohol/records/{id}/retention-decision |
Decide over a record whose retention ended: keep it or mark it for deletion | Company session |
| POST | /compliance/drug-alcohol/records/{id}/void |
Void a wrong record (it stays in the file, voided, and stops counting) | Company session |
| GET | /compliance/drug-alcohol/retention-ended |
Records whose retention ended and that were not marked for deletion | Company session |
| GET | /compliance/drug-alcohol/subject-options |
People and active applications by name, to choose whom a new record is of | Company session |
| GET | /compliance/expirations |
The items with a validity, by date: person, item, date, days left and status (tabs “Next 60 days”, “Expired”, “All”) | Company session |
| GET | /compliance/expirations/item-types |
The item types of the filter of the list | Company session |
| POST | /compliance/expirations/remind |
“Remind driver” and “Remind selected”: tells the driver of each item to send the new document | Company session |
| GET | /compliance/expirations/summary |
The counts of the Home: “Documents expiring in 30 days” and “Expired documents”, the same rows as the list | Company session |
| GET | /compliance/onboarding-templates |
Onboarding templates: search by name, filter by role and employment type | Company session |
| POST | /compliance/onboarding-templates |
Create an onboarding template with its tasks | Company session |
| GET | /compliance/onboarding-templates/choices |
The choices of the template form: the active users and the rules, document types and contract templates a task may be linked to | Company session |
| GET | /compliance/onboarding-templates/{id} |
An onboarding template with its tasks in order | Company session |
| PATCH | /compliance/onboarding-templates/{id} |
Change an onboarding template; tasks, when sent, replaces every task |
Company session |
| POST | /compliance/onboarding-templates/{id}/archive |
Archive an onboarding template: no new onboarding uses it | Company session |
| POST | /compliance/onboarding-templates/{id}/reactivate |
Reactivate an archived onboarding template | Company session |
| GET | /compliance/onboarding/people/{personId} |
The onboarding of a person, or the template that would start it | Company session |
| POST | /compliance/onboarding/people/{personId}/start |
Start the onboarding of a person from the template that applies | Company session |
| POST | /compliance/onboarding/plans/{planId}/complete |
“Mark onboarding complete” | Company session |
| POST | /compliance/onboarding/plans/{planId}/tasks |
“Add task”: a task added to the onboarding of a person | Company session |
| GET | /compliance/onboarding/progress |
The progress of the onboarding of each person (“4 of 9”), up to 200 people | Company session |
| POST | /compliance/onboarding/tasks/{taskId}/complete |
Mark an open task done (its task in the task list of the assignee too) | Company session |
| POST | /compliance/onboarding/tasks/{taskId}/skip |
“Skip” an open task, with the reason | Company session |
| GET | /compliance/overview/counts |
Counts of the overview: compliant, pending, expired, eligible, waiting for review and expiring in 30 days | Company session |
| GET | /compliance/overview/queue |
“What is missing”: the people and candidates not eligible, nearest to eligible first | Company session |
| GET | /compliance/people/{personId}/credentials |
Endorsements and credentials of a person, active first | Company session |
| POST | /compliance/people/{personId}/credentials |
Add an endorsement or a credential | Company session |
| PATCH | /compliance/people/{personId}/credentials/{id} |
Change the name, the number or the validity (only the fields sent) | Company session |
| POST | /compliance/people/{personId}/credentials/{id}/archive |
Archive an endorsement or a credential (nothing is deleted) | Company session |
| POST | /compliance/people/{personId}/credentials/{id}/file |
Attach the file of the credential (JPEG, PNG, WebP, PDF or DOCX, up to 25 MB) | Company session |
| GET | /compliance/rules |
The catalog rules for the company type of operation, with the company switch | Company session |
| PATCH | /compliance/rules/{id} |
Turn an optional rule off or back on; the driver files follow | Company session |
| GET | /compliance/rules/{id}/impact |
How many open driver files a switch of the rule changes, for the confirmation | Company session |
| GET | /compliance/safety-history |
“Previous employers”: the safety history requests of the company, newest first | Company session |
| GET | /compliance/safety-history/driver-files/{driverFileId}/employers |
What “Request safety history” shows for a driver file | Company session |
| POST | /compliance/safety-history/driver-files/{driverFileId}/no-dot-employment |
Records that the driver had no DOT-regulated employer in the past 3 years | Company session |
| POST | /compliance/safety-history/driver-files/{driverFileId}/requests |
“Request safety history”: one request by email per employer picked | Company session |
| GET | /compliance/safety-history/requests/{id} |
A safety history request, with its attempts and its answer | Company session |
| POST | /compliance/safety-history/requests/{id}/attempts |
“Log attempt”: a contact made outside the system (phone, fax, letter) | Company session |
| POST | /compliance/safety-history/requests/{id}/cancel |
“Cancel request”: the link stops working and no reminder leaves | Company session |
| GET | /compliance/screenings |
Screening requests of the company, newest first | Company session |
| POST | /compliance/screenings |
“New request”: one screening for a driver file | Company session |
| GET | /compliance/screenings/assignees |
Active users of the company: who follows a request, and the road test examiner | Company session |
| GET | /compliance/screenings/due-this-month |
“Due this month”: the periodic reviews (annual MVR) that expire this month | Company session |
| POST | /compliance/screenings/pre-hire |
“Start pre-hire screening” of an application | Company session |
| GET | /compliance/screenings/{id} |
A screening request, with its review and the item it fulfills | Company session |
| POST | /compliance/screenings/{id}/requested |
“Mark as requested”: the day, where it was asked and who follows it | Company session |
| POST | /compliance/screenings/{id}/result |
“Attach result”: the file received (multipart, field file, optional receivedOn) |
Company session |
| POST | /compliance/screenings/{id}/review |
“Review”: the result and the note; the item of the driver file is approved | Company session |
| POST | /compliance/screenings/{id}/road-test |
The road test form, sent to the examiner to sign inside the session | Company session |
People
Section titled “People”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /people/access |
Checks that the People module is on and the caller may open it | Company session |
| GET | /people/directory |
People of the active company: search by name, email or phone; filter by role, employment, status, terminal, CDL class and endorsements | Company session |
| POST | /people/directory |
Create a person | Company session |
| GET | /people/directory/account-options |
User accounts with access to the company and not linked to a person yet (id, name, email) | Company session |
| GET | /people/directory/options |
People who can manage (not archived, not terminated) as choices (id, name, role) for manager pickers | Company session |
| GET | /people/directory/{id} |
A person with terminal, manager and linked account | Company session |
| PATCH | /people/directory/{id} |
Change a person (only the fields sent) | Company session |
| POST | /people/directory/{id}/archive |
Archive a person (they leave the lists; nothing is deleted) | Company session |
| POST | /people/directory/{id}/reactivate |
Reactivate an archived person | Company session |
| GET | /people/terminals |
Terminals of the active company: search by name or city, filter by state | Company session |
| POST | /people/terminals |
Create a terminal | Company session |
| GET | /people/terminals/options |
Active terminals as choices (id, name, city, state) for job, vehicle and person forms and list filters | Company session |
| GET | /people/terminals/{id} |
A terminal with its manager and number of people | Company session |
| PATCH | /people/terminals/{id} |
Change a terminal (only the fields sent) | Company session |
| POST | /people/terminals/{id}/archive |
Archive a terminal (it leaves the lists; nothing is deleted) | Company session |
| POST | /people/terminals/{id}/reactivate |
Reactivate an archived terminal | Company session |
| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /fleet/access |
Checks that the Fleet module is on and the caller may open it | Company session |
| GET | /fleet/vehicles |
Vehicles of the active company: search by unit number, VIN or plate; filter by type, status, ownership and terminal | Company session |
| POST | /fleet/vehicles |
Create a vehicle | Company session |
| GET | /fleet/vehicles/{id} |
A vehicle with its terminal | Company session |
| PATCH | /fleet/vehicles/{id} |
Change a vehicle (only the fields sent) | Company session |
| POST | /fleet/vehicles/{id}/archive |
Archive a vehicle (it leaves the lists; nothing is deleted) | Company session |
| POST | /fleet/vehicles/{id}/reactivate |
Reactivate an archived vehicle | Company session |
Operations
Section titled “Operations”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /operations/access |
Checks that the Operations module is on and the caller may open it | Company session |
| GET | /operations/customers |
Customers of the active company: search by name, MC or DOT; filter by type, status and billing state | Company session |
| POST | /operations/customers |
Create a customer with its contacts | Company session |
| GET | /operations/customers/options |
Active customers as choices (id, name, type, billing city and state) for the location form and filter | Company session |
| GET | /operations/customers/{id} |
A customer with its contacts and number of active locations | Company session |
| PATCH | /operations/customers/{id} |
Change a customer (only the fields sent; contacts replaces every contact) |
Company session |
| POST | /operations/customers/{id}/archive |
Archive a customer (it leaves the lists; nothing is deleted) | Company session |
| POST | /operations/customers/{id}/reactivate |
Reactivate an archived customer | Company session |
| GET | /operations/locations |
Locations of the active company: search by name, city, street or ZIP; filter by customer, state and map point | Company session |
| POST | /operations/locations |
Create a location | Company session |
| GET | /operations/locations/{id} |
A location with its customer, map point, hours and contact | Company session |
| PATCH | /operations/locations/{id} |
Change a location (only the fields sent) | Company session |
| POST | /operations/locations/{id}/archive |
Archive a location (it leaves the lists; nothing is deleted) | Company session |
| POST | /operations/locations/{id}/reactivate |
Reactivate an archived location | Company session |
Driver app
Section titled “Driver app”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /driver/access |
Checks that the Driver module is on and the caller may open it | Company session |
Portals
Section titled “Portals”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /portals/access |
Checks that the Portals module is on and the caller may open it | Company session |
Finance
Section titled “Finance”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /finance/access |
Checks that the Finance module is on and the caller may open it | Company session |
Public pages and lead API
Section titled “Public pages and lead API”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /public/applications/{companySlug}/draft |
The saved form of a device | No session |
| PUT | /public/applications/{companySlug}/draft |
Saves a step of the application form | No session |
| POST | /public/applications/{companySlug}/draft/resume-link |
Emails the link to continue the application to the address saved in the draft | No session |
| POST | /public/applications/{companySlug}/draft/token |
Trades the one-time code of the link of the email for a new token of the draft | No session |
| GET | /public/applications/{companySlug}/form |
What the application form shows: company, job, questions and consent texts | No session |
| POST | /public/applications/{companySlug}/submit |
Submits the application | No session |
| GET | /public/careers/{companySlug} |
Company of a careers page: name, title, introduction and logo address | No session |
| GET | /public/careers/{companySlug}/jobs |
Published jobs of a company, newest first, filtered by state and driver type | No session |
| GET | /public/careers/{companySlug}/jobs/{jobSlug} |
A published job of a company | No session |
| GET | /public/careers/{companySlug}/logo |
Logo of the careers page of a company | No session |
| GET | /public/full-application/{companySlug}/application |
The full application of a link: what was saved, the step it stopped at and what is missing | No session |
| POST | /public/full-application/{companySlug}/consents |
Accepts one text of the full application, apart from the others | No session |
| GET | /public/full-application/{companySlug}/copy |
The signed copy of the full application, with the proof of the signature | No session |
| POST | /public/full-application/{companySlug}/documents/{docKind} |
Sends the photo of a document of the full application | No session |
| GET | /public/full-application/{companySlug}/documents/{fileRef} |
The bytes of a photo sent by this link | No session |
| PUT | /public/full-application/{companySlug}/locale |
Changes the language of the full application | No session |
| POST | /public/full-application/{companySlug}/signature |
Signs the full application: the typed name over the prepared document | No session |
| GET | /public/full-application/{companySlug}/signature/document |
The PDF the candidate is about to sign | No session |
| POST | /public/full-application/{companySlug}/signature/prepare |
Makes the document of the full application, to be read and signed | No session |
| PUT | /public/full-application/{companySlug}/steps/addresses |
Saves step 2 of the full application: the addresses of the last 3 years | No session |
| PUT | /public/full-application/{companySlug}/steps/documents |
Closes step 7 of the full application when the photos are there | No session |
| PUT | /public/full-application/{companySlug}/steps/employments |
Saves step 4 of the full application: the employment history and the explanation of its gaps | No session |
| PUT | /public/full-application/{companySlug}/steps/history |
Saves step 5 of the full application: experience, accidents and violations | No session |
| PUT | /public/full-application/{companySlug}/steps/licenses |
Saves step 3 of the full application: the licenses | No session |
| PUT | /public/full-application/{companySlug}/steps/personal |
Saves step 1 of the full application: name, Social Security number, date of birth, phone and email | No session |
| PUT | /public/full-application/{companySlug}/steps/questions |
Saves step 6 of the full application: the yes or no questions | No session |
| GET | /public/interview-calendars/{file} |
The calendar of a recruiter (.ics), read only, by the token of its address | No session |
| POST | /public/leads |
Landing page contact form | No session |
| POST | /public/links/{code}/open |
Counts a visit of a short link and answers the careers page path to redirect to | No session |
| GET | /public/portal/{companySlug}/area |
The area of a link: the stage, what is needed and what was sent | No session |
| GET | /public/portal/{companySlug}/files/{fileRef} |
The bytes of a document this link sent | No session |
| POST | /public/portal/{companySlug}/needed/{ref}/document |
Sends the document of an item of needed: a photo or a file |
No session |
| POST | /public/portal/{companySlug}/needed/{ref}/signing-link |
The address of the signing page of a document of needed |
No session |
| GET | /public/safety-history/authorization |
The authorization the driver signed, as a PDF | No session |
| GET | /public/safety-history/request |
What the response page of a previous employer shows | No session |
| POST | /public/safety-history/respond |
The answer of the previous employer, signed with the full name typed | No session |
| POST | /public/scheduling/{companySlug}/book |
Books the interview of a scheduling link at one of its free times | No session |
| GET | /public/scheduling/{companySlug}/calendar |
The interview of a scheduling link as an iCalendar file (.ics) | No session |
| POST | /public/scheduling/{companySlug}/cancel |
Cancels the interview of a scheduling link | No session |
| POST | /public/scheduling/{companySlug}/confirm |
The candidate confirms they will attend the interview of a scheduling link | No session |
| GET | /public/scheduling/{companySlug}/invitation |
What the scheduling page shows: company, job, interview and the state of the link | No session |
| POST | /public/scheduling/{companySlug}/reschedule |
Moves the interview of a scheduling link to another of its free times | No session |
| GET | /public/scheduling/{companySlug}/slots |
The free times of a scheduling link in the next 14 days, in UTC | No session |
| POST | /public/scheduling/{companySlug}/waitlist |
Puts the application of a scheduling link on the waiting list of its interview type | No session |
| GET | /public/signing/{companySlug}/copy |
The signed copy of a signing link: the document and its signature certificate | No session |
| POST | /public/signing/{companySlug}/decline |
The signer of a signing link refuses to sign: the envelope ends | No session |
| GET | /public/signing/{companySlug}/document |
The document of a signing link, as the PDF every signer reads | No session |
| GET | /public/signing/{companySlug}/envelope |
What the signing page shows: company, document, signers by name and the state | No session |
| POST | /public/signing/{companySlug}/sign |
Signs the document of a signing link with the full name typed | No session |
| GET | /public/unsubscribe/{companySlug} |
What the unsubscribe page shows: the company and whether it is already done | No session |
| POST | /public/unsubscribe/{companySlug} |
Unsubscribes the address of an unsubscribe link from the emails of its company | No session |
| POST | /public/v1/leads |
Send one lead to the company of the API key | No session |
Platform panel
Section titled “Platform panel”| Method | Path | What it does | Access |
|---|---|---|---|
| POST | /admin/auth/login |
Platform team sign in | No session |
| POST | /admin/auth/logout |
Platform team sign out (deletes the panel session) | Platform panel session |
| GET | /admin/auth/me |
The signed-in platform team member | Platform panel session |
| GET | /admin/auth/session |
Panel session probe: the signed-in member, or null without a panel session | No session |
| GET | /admin/calendars |
The calendar providers, configured or not, and the redirect address to register | Platform panel session |
| POST | /admin/calendars/oauth/complete |
Test configuration: finish with what the provider sent back | Platform panel session |
| PUT | /admin/calendars/{provider} |
Save the OAuth application of a calendar provider | Platform panel session |
| DELETE | /admin/calendars/{provider} |
Remove a calendar provider | Platform panel session |
| POST | /admin/calendars/{provider}/test |
Test configuration: the address of the provider to sign in with your own account | Platform panel session |
| GET | /admin/compliance-rules |
The global compliance catalog, with who validated each rule and when | Platform panel session |
| POST | /admin/compliance-rules/{id}/revert |
Revert a rule to preview | Platform panel session |
| POST | /admin/compliance-rules/{id}/validate |
Mark a rule as validated | Platform panel session |
| GET | /admin/consent-texts |
The consent text in force of each channel and language, with who validated it and when | Platform panel session |
| POST | /admin/consent-texts/{id}/revert |
Revert a consent text to preview | Platform panel session |
| POST | /admin/consent-texts/{id}/validate |
Mark a consent text as validated | Platform panel session |
| POST | /admin/invitations/accept |
Accept a platform team invitation | No session |
| POST | /admin/invitations/preview |
Email and state of a platform team invitation token | No session |
| GET | /admin/legal-texts |
The legal text in force of each key and language, with who validated it and when | Platform panel session |
| POST | /admin/legal-texts/{id}/revert |
Revert a legal text to preview | Platform panel session |
| POST | /admin/legal-texts/{id}/validate |
Mark a legal text as validated | Platform panel session |
| GET | /admin/messaging/price |
The estimated price of an SMS segment, with who set it and when | Platform panel session |
| PUT | /admin/messaging/price |
Set the estimated price of an SMS segment (null clears it) | Platform panel session |
| GET | /admin/messaging/system-texts |
The system texts in force (stop words, replies, unsubscribe footer) with the mark | Platform panel session |
| POST | /admin/messaging/system-texts/{id}/revert |
Revert a system text to preview | Platform panel session |
| POST | /admin/messaging/system-texts/{id}/validate |
Mark a system text as validated | Platform panel session |
| GET | /admin/messaging/tenants |
Companies with their SMS number, A2P registration and usage of the month | Platform panel session |
| PUT | /admin/messaging/tenants/{id}/a2p-status |
Record the situation of the A2P 10DLC registration of a company | Platform panel session |
| PUT | /admin/messaging/tenants/{id}/sender |
Assign, change or remove the SMS number of a company | Platform panel session |
| GET | /admin/staff |
Active platform team members and open invitations | Platform panel session |
| POST | /admin/staff/invitations |
Invite an email to the platform team (or send the invitation again) | Platform panel session |
| DELETE | /admin/staff/invitations/{id} |
Revoke an open platform team invitation | Platform panel session |
| DELETE | /admin/staff/{id} |
Remove a platform team member | Platform panel session |
| GET | /admin/tenants |
Companies, newest first: search by name, filter by status, cursor pagination | Platform panel session |
| GET | /admin/tenants/{id} |
A company with its module switches | Platform panel session |
| PATCH | /admin/tenants/{id}/modules/{key} |
Turn a module of a company on or off | Platform panel session |
Health
Section titled “Health”| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /health |
Liveness and readiness: database, Redis and audit partitions; the commit running | No session |