Smart Recruit

API Endpoints

Contents

AccountApprover

Account

POST account

Create a user

Returns

The ID and access token of the newly created user

PUT account/details

Update current (token) user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Boolean for success/fail

PUT account

Update user for id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Boolean for success/fail

GET account/details

Get account details

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An account object

GET account

Get all accounts for company accounts

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An account object

POST account/company

Set current token user's company if they are super user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

New token with company ID

POST account/user

Create a new user if he is allowed to manage sub accounts

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Newly created user if successful

GET account/users

Allow company/user to search and get a paginated and filterable list of users

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of filtered users

DELETE account/user

Delete a single user, if he is allowed to manage sub accounts

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An account_id of the deleted user

DELETE account/users

Delete multiple users, if current user is allowed to manage sub accounts

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Account Id's of the deleted users

PUT account/user

Update a new user if he is allowed to manage sub accounts

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A new Updated User

PUT account/activate/:token

Allow users to activate their account

Returns

Account Activated successfully

POST account/verify

Send email containing verification links to PENDING account

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Verification Email has been sent sucessfully

POST account/suspended

Change status to suspended for one user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Updated user

AccountEmail

AccountGroup

POST accountgroup

Create a new group

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

New group as an object

PUT accountgroup

Update group

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Updated group

GET accountgroup

Get all groups

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An array of group objects

DELETE accountgroup

Delete group

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Server status

AgencyClientAppNote

AgencyClient

Agency

AgencySharedApplication

Application

GET application

Get applications for job id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An array of application objects

GET application/statuses

Get statuses for Jobs

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of statuses for job.

ApplicationForm

POST applicationform

Create new Custom and all FormQuestions

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A successful response message

GET applicationform/:id

To get all details of single custom form

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A CustomForm

DELETE applicationform/:id

Delete a single CustomForm based on id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A deleted CustomForm

GET applicationform

Allow company/user to search and get a paginated and filterable list of CustomForm

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of filtered CustomForm

POST applicationform

Update Custom Form

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Custom Form with FromQuestions

ApplicationNote

POST applicationnote

Create a new ApplicationNote

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A new created Application Note

GET applicationnote:/id

Find all the notes based on Application id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Candidate with application

GET applicationnote/app-note/:id/note/:note_id

Delete Application Note based on app_id and note_id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Candidate with application

ApplicationSlot

ApplicationStatus

ApplicationTag

POST applicationtag

Create a tag

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The tab object for the newly created tag

GET applicationtag

Get tags for user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of tags

PUT applicationtag

Update tag for ID

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The tab object for the updated tag

DELETE applicationtag

Delete tag for ID

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The tab object for the updated tag

Approval

Approver

Auth

POST auth

Create an auth token

Returns

Returns user object and access token if successful

POST auth

Send a reset password email

Returns

Returns success message

PUT auth

Verify reset password email link token and reset to new password

Returns

Returns success message

BackgroundForm

Calendar

CandidateAccount

Candidate

GET candidate

Get candidates for job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An array of candidate objects

POST candidate

Create Candidate manually

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A newly created candidate with application

POST candidate

Select Candidate from another job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Candidate with application

GET candidates

List candidates

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

undefined

CandidateDocument

POST candidatedocument

Add CV to application

Returns

If successful returns the CV object

GET candidatedocument

Get list of CVs for job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Returns array of CV objects

GET candidatedocument/download

Download CV

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Download URL for file

CareersPage

CareersPortal

POST careersportal

Create new careers portal

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Object of newly created careers portal

PUT careersportal

Update existing careers portal

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Object of newly updated careers portal

GET careersportal/

Show feed of latest jobs

Returns

JSON or XML of job feed

ClientJob

Company

POST company

Create a company

Returns

The ID of the newly created company

PUT company

Update current (token) company

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Boolean for success/fail

GET company/child-companies

If the user is a super user, get all of the companies they can control

Returns

An object of all of the companies that can be controlled

CompanyReason

CustomProps

Division

EmailTplAttachments

Event

POST event

Create a calendar event

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The event object for the created event

GET event

Get events for user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of jobs, number of jobs returned and the number of new applications

GET event

Get an event by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The updated event object

PUT event

Update an event by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An object of the updated events

DELETE event

Soft delete an event by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

200 ok http response

POST event/invite

Invite a person using their email

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

undefined

POST event/invite/remove

Remove an invite using email

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

undefined

GET event/accept

Accept an invitation using a unique code

Returns

undefined

GET event/decline

Decline an invitation using a unique code

Returns

undefined

Faq

POST faq

Create a faq

Returns

A successful response FAQ

GET faq

Get FAQs for user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of FAQs

GET faq/id

To get all the details of the faq by ID

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A Faq

Feed

Google

Interview

JobCategory

GET jobcategory

Get job categories for user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of job categories

Job

POST job

Create a job. This creates a draft (the first stage)

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The job object for the newly created job

POST jobjob/:id/note

Create a note for specific job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A newly created note for current job

GET jobjob/:id/notes

Find all the notes for specific job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A List of notes for current job

DELETE jobjob/:id/note/:note_id

Delete a note for specific job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A deleted note

PUT jobjob/:id/note/:note_id

Update a note for specific job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A updated note for current job

DELETE jobjob/:id

Set the Job Status to Archived

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Archived Job

PUT job/advertise

Advertise job. This completes job creation (the final stage)

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The job object for the newly created job

GET job/notifications

Get all notifications for an job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A list of settings for notifications

POST job/notification

Add a user to receive notifications for the job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Object of newly created job advert notification

PUT job/notification

Update a notification by it's ID

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Object of newly updated job advert notification

DELETE job/notification

Delete a notification by it's ID

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

200 ok http response

GET job

Get jobs for user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of jobs, number of jobs returned and the number of new applications

GET job

Get job by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of jobs with applicant numbers (total applicants, total hired, total interviewed and total declined). Also shows candidates for job.

GET job/statuses

Get statuses for Jobs

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of statuses for job.

JobMediaAttachment

POST jobmediaattachment

Create a new job media attachment for a job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The media attachment object for a job advert

GET jobmediaattachment

Get all job media attachment for request

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An job media attachment object

DELETE jobmediaattachment

Destroy a single job media attachment for a job

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The destroyed job media attachment ID

PUT jobmediaattachment

undefined

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Job media attachments have been updated

JobTemplate

GET jobtemplate

Get job template for id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Job template object

Licence

POST licence

Create a new Licence with platform features

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A new Licence with platform features

GET licence

Get all the Licences with platform features

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

All Licences with platform features

GET licence/:id

Get a specific licence by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A licence with platform feature

PUT licence/:id

Update a Licence with platform feature by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Updated Platform feature

DELETE licence/:id

Delete a licence by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Licence with staus_id = 4

POST licence/payment

create a new licence and set create date to the end of current licence and make it inactive

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A new created CompanyLicence

POST licence/upgrade

Calculate the price difference and deactivate their existing licence and create and activate their new licence

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A newly creatd companyLicence

POST licence/downgrade

allow user to downgrade to another lower licence

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Downgraded companyLicence

Location

Media

POST media

Add media to an account's media library

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

If successful returns media object

GET media

Get all of the media that belong to the current user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A list of media

PUT media

Update a specified piece of media

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

The updated media object

DELETE media

Soft delete a specified piece of media

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

200 http response code (ok)

GET media/download

Download media

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Download URL for file

GET media/share/download

Download shared media

Returns

Download URL for file

Message

POST message

Send an Email to user with attachment and save record in db

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A successful response message

POST message

User can update draft message details with add or delete attachments

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A successful response message that message has been updated to draft successfully

POST message

User can send draft message

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A successful response message that message has been sent and saved successfully

POST message/reply

Reply an Email to user with attachment and save record in db

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A successful response message

POST message

To save an email with attachment to db

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A successful response message

GET message/:id

To get all the details of message by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A message

GET messagethread/:id

To get all the details of message by threadId

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A message

PUT message/:id

update the isRead property to true

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A updated message

GET message/messages

To Search or filter messages by message_type

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

All messages

GET message/messages/email-addresses

To get all email addresses of current company

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of EmailAddresses

Migration

Note

Notification

GET notification

Find all notifications belonging to current user

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An object with all notifications

PUT notificationread

Set notification as read

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

200 ok http response

GET notificationsubscribe

Set current user's socket id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An object with all notifications

NotificationSetting

GET notificationsetting

Find all notification settings

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An object with all notification settings

PUT notificationsetting

Update one notification setting

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

An object of the newly update notification setting

Outlook

PlatformFeature

POST platformfeature

Create a new platform feature

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A new platform feature

GET platformfeature

Get all the platform features

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

All platform feature

GET platformfeature/:id

Find platform feature by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Platform feature

PUT platformfeature/:id

Updated a platform feature by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Updated Platform feature

DELETE platformfeature/:id

Delete a platform feature by id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

platform feature has been deleted successfully

Prism

Product

GET product/products

Allow user to getAll products including private products for company

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A list of products including private or public company products

GET product/product/:id

Allow user to get details of a specific product

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A product including private or public company products

GET product/product-types

Allow user to get all the types of products

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A List of product types

GET product/products/inventory

Allow user to get all the company products with title and quantity

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

A List of Inventory products

Questionnaire

POST questionnaire

Create a link between job and custom form

Returns

The ID if newly created link

GET questionnaire/find

get list of forms on basis of job id

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Custom form corresponding to job id sent

Report

GET report/orders

Get all orders for current logged-in user. (pagination parameters accepted here)

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

orders. by default 20 records will be returned

GET report/orders/summary

Get orders summary

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

orders. by default 20 records will be returned

ScheduledReporting

Search

GET search

Account wide search against text

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

List of jobs, number of jobs returned and the number of new applications

StandardGrading

Template

Test

VideoProfiling

XmlToJson

POST xmltojson

Convert xml into standardized json

Returns

json of xml

POST xmltojson

save json into elastic search

Requires auth (can be passed in the header "Authorization: Bearer [token]")

Returns

Candidate with application

admin/Account

admin/AdminAccount

admin/BroadbeanAccount

admin/Candidate

admin/Company

admin/CompanyProduct

admin/GlobalSetting

admin/JobBoard

admin/JobBoardProduct

admin/Job

admin/LicencePlatformFeatures

admin/Notification

admin/Order

admin/Product

admin/ScheduledReporting

admin/StandardTemplate