API Reference

/jobs/:shortcode/activities

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

Log in to see full request history

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
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 disqualification
ratingobjectContains the score of the activity, if action is rating
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
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json