Referrals

Get referral by email

To get the details of a referral you need to issue a GET request to the following endpoint.

This endpoint will return all of the matching referrals for the given email address as a list.

GET /v3/referrals?email=:email

Query Params

Name	Type	Description
email	string	The email address used to search for referrals

Example Request

GET v3/referrals?email=petersmith@gmail.com

Example Response

[
    {
        "application_status": "new",
        "department": "Sales",
        "email": "petersmith@gmail.com",
        "first_name": "Peter",
        "job_id": "76552",
        "job_title": "Sales Exec",
        "last_name": "Smith",
        "location_id": "London, England, United Kingdom",
        "phone": "+4478765678765",
        "profiles": {
            "linkedin": "https://www.linkedin.com/PeterSmith"
        },
        "ref_type": [
            "employee",
            "direct"
        ],
        "referral_date": "2015-09-30T16:19:18.128901",
        "referrer": "John Brown <johnbrown@globalcompany.com> (e12345)",
        "referrers": [
            {
                "email": "johnbrown@globalcompany.com",
                "first_name": "John",
                "last_name": "Brown",
                "employee_id": "e12345"
            }
        ],
        "status": "referral"
    }
]

Edit a Referral

To update the attributes of a referral you need to issue a PATCH request to the following endpoint.

PATCH /v3/referrals/:referral_id

Parameters

Name	Type	Description
application_status	string	The new status of the application, must be one of: new, application started, contacted, application completed, under assessment, job offered, archived, hired, hired, probation complete.

Example Request

{
    "application_status": "new"
}

Example Response

{
    "application_status": "new"
}

Job Applications

Edit a Job Application

To update the attributes of a job application you need to issue a PATCH request to the following endpoint.

PATCH /v3/job_applications/:application_id

Parameters

Name	Type	Description
application_status	string	The new status of the application, must be one of: new, application started, contacted, application completed, under assessment, job offered, archived, hired, hired, probation complete.

Example Request

{
    "application_status": "new"
}

Example Response

{
    "application_status": "new"
}