Create a user
The ID and access token of the newly created user
Update current (token) user
Boolean for success/fail
Update user for id
Boolean for success/fail
Get account details
An account object
Get all accounts for company accounts
An account object
Set current token user's company if they are super user
New token with company ID
Create a new user if he is allowed to manage sub accounts
Newly created user if successful
Allow company/user to search and get a paginated and filterable list of users
List of filtered users
Delete a single user, if he is allowed to manage sub accounts
An account_id of the deleted user
Delete multiple users, if current user is allowed to manage sub accounts
Account Id's of the deleted users
Update a new user if he is allowed to manage sub accounts
A new Updated User
Allow users to activate their account
Account Activated successfully
Send email containing verification links to PENDING account
Verification Email has been sent sucessfully
Change status to suspended for one user
Updated user
Create a new group
New group as an object
Update group
Updated group
Get all groups
An array of group objects
Delete group
Server status
Get applications for job id
An array of application objects
Get statuses for Jobs
List of statuses for job.
Create new Custom and all FormQuestions
A successful response message
To get all details of single custom form
A CustomForm
Delete a single CustomForm based on id
A deleted CustomForm
Allow company/user to search and get a paginated and filterable list of CustomForm
List of filtered CustomForm
Update Custom Form
Custom Form with FromQuestions
Create a new ApplicationNote
A new created Application Note
Find all the notes based on Application id
Candidate with application
Delete Application Note based on app_id and note_id
Candidate with application
Create a tag
The tab object for the newly created tag
Get tags for user
List of tags
Update tag for ID
The tab object for the updated tag
Delete tag for ID
The tab object for the updated tag
Create an auth token
Returns user object and access token if successful
Send a reset password email
Returns success message
Verify reset password email link token and reset to new password
Returns success message
Get list of CVs for job
Returns array of CV objects
Download CV
Download URL for file
Create new careers portal
Object of newly created careers portal
Update existing careers portal
Object of newly updated careers portal
Show feed of latest jobs
JSON or XML of job feed
Create a company
The ID of the newly created company
Update current (token) company
Boolean for success/fail
If the user is a super user, get all of the companies they can control
An object of all of the companies that can be controlled
Create a calendar event
The event object for the created event
Get events for user
List of jobs, number of jobs returned and the number of new applications
Get an event by id
The updated event object
Update an event by id
An object of the updated events
Soft delete an event by id
200 ok http response
Invite a person using their email
undefined
Remove an invite using email
undefined
Accept an invitation using a unique code
undefined
Decline an invitation using a unique code
undefined
Create a faq
A successful response FAQ
Get FAQs for user
List of FAQs
To get all the details of the faq by ID
A Faq
Get job categories for user
List of job categories
Create a job. This creates a draft (the first stage)
The job object for the newly created job
Create a note for specific job
A newly created note for current job
Find all the notes for specific job
A List of notes for current job
Delete a note for specific job
A deleted note
Update a note for specific job
A updated note for current job
Set the Job Status to Archived
Archived Job
Advertise job. This completes job creation (the final stage)
The job object for the newly created job
Get all notifications for an job
A list of settings for notifications
Add a user to receive notifications for the job
Object of newly created job advert notification
Update a notification by it's ID
Object of newly updated job advert notification
Delete a notification by it's ID
200 ok http response
Get jobs for user
List of jobs, number of jobs returned and the number of new applications
Get job by id
List of jobs with applicant numbers (total applicants, total hired, total interviewed and total declined). Also shows candidates for job.
Get statuses for Jobs
List of statuses for job.
Create a new job media attachment for a job
The media attachment object for a job advert
Get all job media attachment for request
An job media attachment object
Destroy a single job media attachment for a job
The destroyed job media attachment ID
undefined
Job media attachments have been updated
Get job template for id
Job template object
Create a new Licence with platform features
A new Licence with platform features
Get all the Licences with platform features
All Licences with platform features
Get a specific licence by id
A licence with platform feature
Update a Licence with platform feature by id
Updated Platform feature
Delete a licence by id
Licence with staus_id = 4
create a new licence and set create date to the end of current licence and make it inactive
A new created CompanyLicence
Calculate the price difference and deactivate their existing licence and create and activate their new licence
A newly creatd companyLicence
allow user to downgrade to another lower licence
Downgraded companyLicence
Add media to an account's media library
If successful returns media object
Get all of the media that belong to the current user
A list of media
Update a specified piece of media
The updated media object
Soft delete a specified piece of media
200 http response code (ok)
Download media
Download URL for file
Download shared media
Download URL for file
Find all notification settings
An object with all notification settings
Update one notification setting
An object of the newly update notification setting
Create a new platform feature
A new platform feature
Get all the platform features
All platform feature
Find platform feature by id
Platform feature
Updated a platform feature by id
Updated Platform feature
Delete a platform feature by id
platform feature has been deleted successfully
Allow user to getAll products including private products for company
A list of products including private or public company products
Allow user to get details of a specific product
A product including private or public company products
Allow user to get all the types of products
A List of product types
Allow user to get all the company products with title and quantity
A List of Inventory products
Create a link between job and custom form
The ID if newly created link
get list of forms on basis of job id
Custom form corresponding to job id sent
Get all orders for current logged-in user. (pagination parameters accepted here)
orders. by default 20 records will be returned
Get orders summary
orders. by default 20 records will be returned
Account wide search against text
List of jobs, number of jobs returned and the number of new applications
Convert xml into standardized json
json of xml
save json into elastic search
Candidate with application
Create a link between job and job questionnaire
The ID if newly created link
get list of forms on basis of job id
job questionnaire corresponding to job id sent