API Directory

Using this API, user will be able to refer a candidate against a job posted for employee referral.

Request

POST https://altrecruit.peoplestrong.com/api/referrals/v1/refer

Request body

The request body takes a complete ReferCandidateRequest resource, containing the following writable properties:

{
    "candidateName": "string",
    "email": "string",
    "expInMonth": "int64",
    "expInYear": "int64",
    "jobCode": "string",
    "mobileNumber": "string",
    "resume": "string",
    "resumeExtension": "string",
    "skills": "string",
    "userName": "string"
}

Properties

Name Type Description Additional
candidateName string

Candidate name

Optional
email string

Candidate email

Optional
expInMonth int64

Experience in months

Optional
expInYear int64

Experience in years

Optional
jobCode string

Job code

Optional
mobileNumber string

Candidate mobile

Optional
resume string

Resume byte stream

Optional
resumeExtension string

Extension of resume file

Optional
skills string

Candidate name

Optional
userName string

Username of referer

Optional

Authorisation

This request requires the use of one of following authorisation methods: API key OAuth2.

For OAuth 2 authorisation, the following scopes are required:

Scope Description
read read records
write modify records

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

ReferCandidateResponse
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

405 Method Not Allowed

Method Not Allowed

426

API rate limit exceeded

429

API rate limit exceeded

500 Internal Server Error

Internal Server Error

default

successful operation


Explore this API

body

Request body referring a candidate

Request Content-Type
Response Content-Type

Choose an authorisation method:

API key API key to be used for request
Access Token Access token to be used for request
Try it out!