API Reference
API Reference

/jobs/:shortcode/activities

Returns the activity stream of the given job. Requires scope r_candidates. Accessible with all token types.

Results

Calling the /jobs/:shortcode/activities endpoint returns a JSON array of the job's activities.

keydescription
activitiesarray of activities

Each activity has the following keys:

keytypedescription
actionstringThe action/type of the activity. See Action values
stage_namestringThe stage the candidate was in when the activity was created (if applicable)
created_atstringThe creation timestamp of the activity
candidateobjectThe candidate (if applicable), contains id and name
memberobjectThe member that created the activity (if applicable), contains id and name of the member
bodystringThe body of the activity, available if action is comment, rating, message or disqualified
ratingobjectContains the score of the activity, if action is rating

Action values

The action key of each activity takes one of the values below. The job activity stream includes both candidate actions and job actions.

Candidate actions

ActionDescription
appliedThe candidate applied to the job.
sourcedThe candidate was moved to a stage of type Sourced.
shortlistedThe candidate was moved to a stage of type Shortlisted.
phone-screenThe candidate was moved to a stage of type Phone screen.
assessmentThe candidate was moved to a stage of type Assessment.
interviewThe candidate was moved to a stage of type Interview.
offerThe candidate was moved to a stage of type Offer.
hiredThe candidate was moved to a stage of type Hired.
uploadedA member added the candidate to the job (including candidates added through AI Recruiter).
copiedA member copied the candidate from another job (including candidates added through AI Recruiter).
movedA member moved the candidate from another job.
referralA member gave a referral for the candidate.
recommendedThe candidate was referred by an employee.
disqualifiedA member disqualified the candidate.
auto-disqualifiedThe candidate was disqualified automatically.
revertedA member reverted the disqualification. The candidate is qualified again.
snoozedA member snoozed the candidate until a date.
unsnoozedA member removed the snooze.
awakenedThe snooze period ended and the candidate is active again.
blockedA member blocked the candidate from all current and future jobs.
unblockedA member unblocked the candidate.
bookmarkedA member saved the candidate for future reference.
unbookmarkedA member removed the candidate from saved.
commentA member added a comment.
ratingA member added an evaluation.
feedbackAn external user provided feedback.
messageAn email or text message was sent to the candidate.
bulk-messageThe candidate was included in a bulk email.
bulk-message-scheduledA bulk email or text message was scheduled for a later date.
automation-scheduledAn automated action (e.g. automated email) for the candidate was scheduled, sent, canceled or failed.
ai_agent_stoppedA member performed manual actions, so Workable Agent stopped contacting, evaluating and advancing the candidate.
sms-consent-forcedA member enabled text messaging for the candidate.
sms-consent-declinedText messaging was disabled for the candidate.
gdpr-policy-notificationThe candidate was notified about a new privacy notice.
eventA member scheduled an event (e.g. interview) with the candidate.
event-requestThe candidate was asked to schedule an event.
event-cancelledA member canceled a scheduled event.
assessment-requestedAn assessment invitation was sent to the candidate.
assessment-completedThe assessment result is available, or the candidate missed the assessment deadline.
assessment-check-requestedA member requested a check (e.g. education reference check) through a background check provider.
assessment-check-completedThe requested check is complete and the results are available.
video-interview-requestedA video interview invitation was sent to the candidate.
video-interview-completedThe candidate completed the video interview.
background-check-requestedA member requested a background check.
background-check-consentedThe candidate consented to the background check.
background-check-completedThe background check is complete.
background-check-pre-adverseA member initiated adverse action based on the background check.
reference-check-requestedA member requested a reference check.
offer-pending-approvalA member sent the offer for approval.
offer-approvedThe offer was approved.
offer-rejectedThe approver did not approve the offer.
offer-scheduledThe offer is scheduled to be sent at a later date.
offer-sentA member sent the offer to the candidate.
offer-acceptedThe candidate accepted and signed the offer.
offer-declinedThe candidate declined the offer.
offer-canceledA member canceled the offer.
offer-expiredThe offer expired.
e-signature-request-sentA member sent a document for signature.
e-signature-request-acceptedThe candidate signed the requested document.
e-signature-request-declinedThe candidate declined to sign the requested document.

Job actions

ActionDescription
publishedA member published the job.
unpublishedA member unpublished the job.
openedA member opened the job for internal use.
opened-confidentiallyA member opened the job confidentially.
archivedA member archived the job.
unarchivedA member unarchived the job.
bulkA member sent a bulk email to candidates of the job.
bulk-smsA member sent or scheduled a bulk text message to candidates of the job.
join-hiring-teamA member requested to join the hiring team of the job.
request-actionA member asked an admin to act on the job (e.g. review and publish, archive, create a requisition).
referral-campaignA member asked for referrals for the job.
pending-evaluationA member's evaluation is pending.
requisition-pending-approvalA member sent a requisition for approval.
requisition-approvedThe requisition was approved.
requisition-rejectedThe requisition was rejected.
requisition-openThe requisition was opened.
requisition-on-holdThe requisition was put on hold.
requisition-resumedThe requisition was resumed after being on hold.
requisition-cancelledThe requisition was canceled.
requisition-edited-opened-onThe open date of the requisition was edited.
requisition-batch-pending-approvalA member sent a requisition batch for approval.
requisition-batch-approvedThe requisition batch was approved.
requisition-batch-rejectedThe requisition batch was rejected.
requisition-batch-openThe requisition batch was opened.
requisition-batch-cancelledThe requisition batch was canceled.
suggested-candidates-requestedLegacy. A member asked AI Recruiter to source candidates for the job.
suggested-candidates-enabledLegacy. AI Recruiter started sourcing candidates for the job.
suggested-candidates-manual-triggerLegacy. A member asked AI Recruiter to search for new sourced candidates again.
suggested-candidates-rejectedLegacy. A request to AI Recruiter could not run because the account did not have enough sourcing credits or its plan did not include AI Recruiter.
past-candidates-requestedLegacy. A member asked AI Recruiter to resurface past candidates for the job.
past-candidates-enabledLegacy. AI Recruiter started resurfacing past candidates for the job.
past-candidates-manual-triggerLegacy. A member asked AI Recruiter to search past candidates again.

Actions marked Legacy come from the original version of AI Recruiter and are no longer generated. They may appear on jobs with activity from before mid-2023. suggested-candidates-* actions refer to new candidates sourced from outside the account; past-candidates-* actions refer to past candidates resurfaced from the account's own database. Candidates added through AI Recruiter today get an uploaded or copied candidate activity.

Path Params
string
required

The job's shortcode

Query Params
int32
Defaults to 50

Specifies the number of members to try and retrieve per page (optional)

string

Returns results with an ID greater than or equal to the specified ID. (optional)

string

Returns results with an ID less than or equal to the specified ID. (optional)

Responses

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