JobAdder API
Documentation Powered by ReDoc

JobAdder API (v2)

Download OpenAPI specification:Download

Getting Started

Authentication

JobAdder uses the OAuth 2.0 authorization code flow to issue API access tokens on behalf of users.

At a high-level, this flow has the following steps:

  • Your application directs the browser to the JobAdder authorization page.
  • The user authenticates and approves your application's request.
  • The user is redirected back to your application with an authorization code in the query string.
  • Your application sends this code to JobAdder to exchange for an API access token and optionally a refresh token.
  • Your application can now use these tokens to call the JobAdder API on behalf of the user.

 

1. Redirect to the JobAdder authorization URL.

Your application should redirect the user to the authorization URL

https://id.jobadder.com/connect/authorize

The following query parameters should be passed with the GET request:

parameter description
response_type code (required)
client_id issued when you created your application (required)
scope permissions to request, see Scopes (required)
redirect_uri URL to redirect back to (required)
state unique string to be passed back (optional)

The scope parameter is a space-separated list of OAuth scopes indicating the desired access. See Scopes for the complete list of scopes.

The redirect_uri parameter must match one of the URLs specified when the client_id was issued.

The state parameter can be provided to carry through server-specific state. For example, you can use this to help prevent forgery attacks.

The user will be presented with a login screen, and then a confirmation screen where they will grant your application access to their JobAdder data.

 

2. Receive an authorization code from JobAdder.

After a successful login, the authorization server will redirect to the URL specified in step 1 passing the following parameters passed with the GET request:

parameter description
code a temporary authorization code
state the unique string specified in step 1

If you passed a state parameter in step 1 then at this point you should compare the state parameter from this request with the state parameter from the request in step 1. If the states don't match then the request may have been created by an unknown third party and you should abort the process.

If your request for access is denied by the user then the user will be redirected to the URL specified in step 1 with the following query parameters passed with the GET request:

parameter value
error access_denied

 

3. Exchange the authorization code for an access token.

The authorization code received in step 2 will remain valid for 5 minutes and should be exchanged for an access token. To do this, submit a POST request to the token URL:

https://id.jobadder.com/connect/token

The following parameters should be included in the POST request:

parameter description
client_id issued when you created your application (required)
client_secret issued when you created your application (required)
grant_type authorization_code (required)
code the temporary authorization code received in step 2 (required)
redirect_uri the URL specified in step 1 (required)

This request will return a JSON response containing the access token, for example

{
  access_token: "31ff7431b4c1dde02e386122702f5460",
  expires_in: 3600,
  token_type: "Bearer",
  refresh_token: "e7672885d6da2db1e56d200dd292c801",
  api: "https://api.jobadder.com/v2"
}
parameter description
access_token token to be used as the Bearer token in the Authorization header of all API requests
expires_in expiration time of the access token in seconds since the response was generated
refresh_token token to be used to request new access tokens
api The base URL to use for API access

 

4. Exchange a refresh token for an access token.

The access token has a limited lifetime (currently 60 minutes). If your application requested the offline_access scope (in step 1) then it is possible to gain extended access to the user's data by requesting a new access token using the refresh token. To do this, submit a POST request to the token URL:

https://id.jobadder.com/connect/token

The following parameters should be included in the POST request:

parameter description
client_id issued when you created your application (required)
client_secret issued when you created your application (required)
grant_type refresh_token (required)
refresh_token the refresh token returned in step 3

This request will return a JSON response containing a new access token and request token.

{
  access_token: "d2534958b2d3b9e3b0e16c98f91f0184",
  expires_in: 3600,
  token_type: "Bearer",
  refresh_token: "e1b495fa69c9bdacbc7e5dd535d4564f",
  api: "https://api.jobadder.com/v2"
}

 

Scopes

Scopes allow you to clearly specify the type of information your application will access and the level of access it will need.

It's a good idea to limit the scopes that you request to the bare minimum so that users will feel confident with your application when granting access to their data.

scope description
read View JobAdder data
write Manage JobAdder data
read_candidate View candidates
write_candidate Manage candidates
read_candidate_note View candidate notes
write_candidate_note Manage candidate notes
manage_candidate_custom Manage candidate custom fields
read_company View companies
write_company Manage companies
read_company_note View company notes
write_company_note Manage company notes
manage_company_custom Manage company custom fields
read_contact View contacts
write_contact Manage contacts
read_contact_note View contact notes
write_contact_note Manage contact notes
manage_contact_custom Manage contact custom fields
read_jobad View job ads
write_jobad Manage job ads
read_jobapplication View job applications
write_jobapplication Manage job applications
read_jobapplication_note View job application notes
write_jobapplication_note Manage job application notes
manage_jobapplication_custom Manage job application custom fields
read_interview View job interviews
read_job View jobs
write_job Manage jobs
read_job_note View job notes
write_job_note Manage job notes
manage_job_custom Manage job custom fields
read_placement View placements
write_placement Manage placements
read_placement_note View placement notes
write_placement_note Manage placement notes
manage_placement_custom Manage placement custom fields
read_requisition View requisitions
write_requisition Manage requisitions
read_requisition_note View requisition notes
write_requisition_note Manage requisition notes
read_float View floats
read_submission View submissions
read_note View notes
write_note Manage notes
read_folder View folders
write_folder Manage folders
read_user View users
read_usergroup View user groups
read_usertask View user tasks
partner_jobboard View active job ads and submit job applications
partner_ui_action Add partner actions to JobAdder
offline_access Access JobAdder data for an extended period of time, must always be combined with other scopes

 

Webhooks

The JobAdder API supports webhooks for event notification using the Webhook API.

The order of webhook notifications are not guaranteed, and idempotency may lead to duplicate notifications.

 

Notification messages

When an event occurs, JobAdder will issue an HTTP POST to the URL you specified on your webhook.

{
  "apiVersion": 2,
  "event": "placement_approved",
  "eventId": "00000000-0000-0000-0000-000000000000",
  "eventDate": "2019-01-01T09:00:00Z",
  "eventUser": {},
  "eventData": {},
  <event details>
}

 

Events

All events require the offline_access scope, along with the scopes relevant to the event.

event name required scopes
job_status_changed read or read_job
job_partner_action read or read_job, partner_ui_action
jobad_posted read or read_jobad
jobad_expired read or read_jobad
jobad_partner_action read or read_jobad, partner_ui_action
candidate_status_changed read or read_candidate
candidate_partner_action read or read_candidate, partner_ui_action
jobapplication_status_changed read or read_jobapplication
jobapplication_partner_action read or read_jobapplication, partner_ui_action
placement_approved read or read_placement
placement_status_changed read or read_placement
placement_partner_action read or read_placement, partner_ui_action
company_status_changed read or read_company
company_partner_action read or read_company, partner_ui_action
contact_status_changed read or read_contact
contact_partner_action read or read_contact, partner_ui_action
interview_scheduled read or read_interview
interview_evaluation_submitted read or read_interview
folder_job_added read or read_job, read or read_folder
folder_job_removed read or read_job, read or read_folder
folder_candidate_added read or read_candidate, read or read_folder
folder_candidate_removed read or read_candidate, read or read_folder
folder_jobapplication_added read or read_jobapplication, read or read_folder
folder_jobapplication_removed read or read_jobapplication, read or read_folder
folder_placement_added read or read_placement, read or read_folder
folder_placement_removed read or read_placement, read or read_folder
folder_company_added read or read_company, read or read_folder
folder_company_removed read or read_company, read or read_folder
folder_contact_added read or read_contact, read or read_folder
folder_contact_removed read or read_contact, read or read_folder

 

Release Notes

Upcoming changes

eta description

Recent changes

date description
2021-01-11 Find Candidates - new filters (current position, city, state)
2021-01-11 Create Pending Candidates when using /candidates/
2020-11-10 Activities (create, find) related endpoints
2019-09-23 FIX: Status change note generation sometimes included an incorrect user name in the note content
2019-07-04 FIX: Find webhooks events query parameter was not filtering the results
2019-06-11 Candidate skill coding
2019-06-03 Additional deleted record endpoints
2019-06-03 embed=self query parameter to embed full details in results returned by key endpoints
2019-05-26 embed=self query parameter to embed full details and related resources on candidates
2019-05-26 /candidates/deleted endpoint added to list recently deleted candidates
2019-05-26 /contacts/deleted endpoint added to list recently deleted contacts
2019-05-25 jobad_posted webhook event
2019-05-25 jobad_expired webhook event
2019-05-16 Optional authorization header on webhook events
2019-05-16 Interview evaluation endpoints
2019-05-16 interview_evaluation_submitted webhook event
2019-05-16 Interview endpoints for related entities
2019-05-09 /interviews endpoint added to list scheduled internal and external interviews
2019-05-09 interview_scheduled webhook event

Job Boards

Find job boards

Authorizations:
jobadder_identity (readread_jobadpartner_jobboard)
query Parameters
boardId
Array of integers <int32>

Job Board Id

Responses

Response Schema: application/json
Array of objects (JobBoardSummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a job board

Authorizations:
jobadder_identity (readread_jobadpartner_jobboard)
path Parameters
boardId
required
integer <int32>

Responses

Response Schema: application/json
boardId
integer <int32>
name
string
reference
string
object (JobBoardPortalModel)

Response samples

Content type
application/json
{
  • "boardId": 0,
  • "name": "string",
  • "reference": "string",
  • "portal": {
    }
}

Job Ads

Find job ads

Authorizations:
jobadder_identity (readread_jobadpartner_jobboard)
path Parameters
boardId
required
integer <int32>
query Parameters
adId
Array of integers <int32>
reference
Array of strings
portal.hotJob
boolean
portal.value
Array of strings
portal.valueId
Array of integers <int32>
portal.template
Array of strings
postedAt
Array of strings

Search for job ads posted at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for job ads updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

expiresAt
Array of strings

Search for job ads expiring at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

fields
Array of strings

Additional fields to include with the results. Fields available to include are: description, portal.fields

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobBoardJobAdSummaryModel)
totalCount
required
integer <int32>
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a job ad

Authorizations:
jobadder_identity (readread_jobadpartner_jobboard)
path Parameters
boardId
required
integer <int32>
adId
required
integer <int32>

Responses

Response Schema: application/json
adId
integer <int32>
title
string
reference
string
summary
string
bulletPoints
Array of strings
description
string
Array of objects (JobAdScreeningQuestionModel)
object (JobAdPortalModel)
postedAt
string <date-time>
updatedAt
string <date-time>
expiresAt
string <date-time>
object (JobBoardJobAdLinks)

Response samples

Content type
application/json
{
  • "adId": 0,
  • "title": "string",
  • "reference": "string",
  • "summary": "string",
  • "bulletPoints": [
    ],
  • "description": "string",
  • "screening": [
    ],
  • "portal": {
    },
  • "postedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Job Applications

Submit a job application

Authorizations:
jobadder_identity (writewrite_jobapplicationpartner_jobboard)
path Parameters
boardId
required
integer <int32>

Job Board Id

adId
required
integer <int32>

Job Ad Id

Request Body schema: application/json
firstName
required
string <= 50 characters
lastName
required
string <= 50 characters
salutation
string
email
required
string <= 100 characters
phone
string <= 50 characters
mobile
string <= 50 characters
object (SubmitAddressModel)
object
object (SubmitEmploymentModel)
object (SubmitCandidateAvailabilityModel)

The date the candidate is available to start. Specify ONE OF immediate, relative or date.

Array of objects (SubmitCandidateEducationModel)
skillTags
Array of strings
object (SubmitScreeningQuesionResultsModel)
object (SubmitJobApplicationCustomFieldsModel)

Candidate and job application custom field values

Responses

Response Schema: application/json
applicationId
integer <int64>
object (SubmittedJobApplicationLinks)

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "salutation": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "address": {
    },
  • "social": {},
  • "employment": {
    },
  • "availability": {
    },
  • "education": [
    ],
  • "skillTags": [
    ],
  • "screening": {
    },
  • "custom": {
    }
}

Response samples

Content type
application/json
{
  • "applicationId": 0,
  • "links": {
    }
}

Submit job application documents

Add a resume, cover letter or related document to a previously submitted job application.
Documents can be added for a duration of 5 minutes after submitting the job application.

Authorizations:
jobadder_identity (writewrite_jobapplicationpartner_jobboard)
path Parameters
boardId
required
integer <int32>

Job Board Id

adId
required
integer <int32>

Job Ad Id

applicationId
required
integer <int64>

Job Application Id

attachmentType
required
string
Enum: "Resume" "FormattedResume" "CoverLetter" "Screening" "Check" "Reference" "License" "Other"
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Jobs

Find jobs

Authorizations:
jobadder_identity (readread_job)
query Parameters
jobId
Array of integers <int32>

Job Id

jobTitle
string

Job title

company.companyId
Array of integers <int32>

Companies by Id

company.name
string

Company name

companyId
Array of integers <int32>

Alias for company.companyId

contactId
Array of integers <int32>

Contact Id

partnerAction.actionId
Array of strings <uuid>

Unique identifier for partner actions

partnerAction.reference
Array of strings

Partner supplied unique reference for the action

partnerAction.stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

partnerAction.submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

statusId
Array of integers <int32>

Job status

active
boolean

Search for active/open jobs

userFavourite
boolean

Search for the user's favourite jobs

folderId
Array of integers <int64>

Search in specific folders

userId
Array of integers <int32>

User Id - search for jobs by owner or associated recruiter

ownerUserId
Array of integers <int32>

User Id - search for jobs by owner

recruiterUserId
Array of integers <int32>

User Id - search jobs by associated recruiters

createdBy
Array of integers <int32>

User Id - search for jobs created by the specified user(s)

createdAt
Array of strings

Search for jobs created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedBy
Array of integers <int32>

User Id - search for jobs last updated by the specified user(s)

updatedAt
Array of strings

Search for jobs updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

closedBy
Array of integers <int32>

User Id - search for jobs last closed by the specified user(s)

closedAt
Array of strings

Search for jobs closed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: jobTitle, status.name, createdAt, updatedAt, closedAt

fields
Array of strings

Additional fields to include with the results. Fields available to include are: recruiters, statistics, partnerActions

embed
Array of strings

Embed related resources.
Resources available to embed are: self, notes, applications

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobOrderSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a job

Authorizations:
jobadder_identity (writewrite_job)
Request Body schema: application/json
jobTitle
required
string <= 100 characters
companyId
integer <int32>
contactId
integer <int32>
jobDescription
string
statusId
integer <int32>

Job status

userFavourite
boolean

Job is a favourite for the current user

object (SubmitCategoryModel)
object (SubmitLocationModel)
workplaceAddressId
string <uuid>

Workplace Address Id

object (SubmitJobOrderStartModel)
object (SubmitDurationModel)
workTypeId
integer <int32>
object (SubmitJobOrderSalaryRangeModel)
object (SubmitJobOrderFeeModel)
numberOfJobs
integer <int32>
source
string <= 50 characters
Array of objects (SubmitCustomFieldValueModel)
object (SubmitJobOrderSkillTagsModel)
ownerUserId
integer <int32>

User Id - Owner of this job

recruiterUserId
Array of integers <int32>

User Id - Optional list of recruiters assigned to the job

Responses

Response Schema: application/json
jobId
required
integer <int32>
jobTitle
string
object (CompanyNameModel)
object (ContactNameModel)
object (StatusModel)
source
string
userFavourite
boolean
jobDescription
string
numberOfJobs
integer <int32>
object (CompanyAddressModel)
object (JobOrderCategoryModel)
object (JobOrderLocationModel)
object (JobOrderStartModel)
object (DurationModel)
object (WorkTypeModel)
object (JobOrderSalaryRangeModel)
object (JobOrderFeeModel)
Array of objects (ContactNameModel)
object (JobOrderSkillTags)
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (UserNameModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (UserNameModel)
closedAt
string <date-time>
object (JobOrderStatisticsSummaryModel)
object (JobOrderLinks)

Request samples

Content type
application/json
{
  • "jobTitle": "string",
  • "companyId": 0,
  • "contactId": 0,
  • "jobDescription": "string",
  • "statusId": 0,
  • "userFavourite": true,
  • "category": {
    },
  • "location": {
    },
  • "workplaceAddressId": "00000000-0000-0000-0000-000000000000",
  • "start": {
    },
  • "duration": {
    },
  • "workTypeId": 0,
  • "salary": {
    },
  • "fee": {
    },
  • "numberOfJobs": 0,
  • "source": "string",
  • "custom": [
    ],
  • "skillTags": {
    },
  • "ownerUserId": 0,
  • "recruiterUserId": [
    ]
}

Response samples

Content type
application/json
{
  • "jobId": 0,
  • "jobTitle": "string",
  • "company": {
    },
  • "contact": {
    },
  • "status": {
    },
  • "source": "string",
  • "userFavourite": true,
  • "jobDescription": "string",
  • "numberOfJobs": 0,
  • "workplaceAddress": {
    },
  • "category": {
    },
  • "location": {
    },
  • "start": {
    },
  • "duration": {
    },
  • "workType": {
    },
  • "salary": {
    },
  • "fee": {
    },
  • "otherContacts": [
    ],
  • "skillTags": {
    },
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "partnerActions": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "closedBy": {
    },
  • "closedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "links": {
    }
}

Get a job

Authorizations:
jobadder_identity (readread_job)
path Parameters
jobId
required
integer <int32>

Job Id

query Parameters
embed
Array of strings

Embed related resources.
Resources available to embed are: applications, notes

Responses

Response Schema: application/json
jobId
required
integer <int32>
jobTitle
string
object (CompanyNameModel)
object (ContactNameModel)
object (StatusModel)
source
string
userFavourite
boolean
jobDescription
string
numberOfJobs
integer <int32>
object (CompanyAddressModel)
object (JobOrderCategoryModel)
object (JobOrderLocationModel)
object (JobOrderStartModel)
object (DurationModel)
object (WorkTypeModel)
object (JobOrderSalaryRangeModel)
object (JobOrderFeeModel)
Array of objects (ContactNameModel)
object (JobOrderSkillTags)
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (UserNameModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (UserNameModel)
closedAt
string <date-time>
object (JobOrderStatisticsSummaryModel)
object (JobOrderLinks)

Response samples

Content type
application/json
{
  • "jobId": 0,
  • "jobTitle": "string",
  • "company": {
    },
  • "contact": {
    },
  • "status": {
    },
  • "source": "string",
  • "userFavourite": true,
  • "jobDescription": "string",
  • "numberOfJobs": 0,
  • "workplaceAddress": {
    },
  • "category": {
    },
  • "location": {
    },
  • "start": {
    },
  • "duration": {
    },
  • "workType": {
    },
  • "salary": {
    },
  • "fee": {
    },
  • "otherContacts": [
    ],
  • "skillTags": {
    },
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "partnerActions": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "closedBy": {
    },
  • "closedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "links": {
    }
}

Update a job

Authorizations:
jobadder_identity (writewrite_job)
path Parameters
jobId
required
integer <int32>
Request Body schema: application/json
jobTitle
required
string <= 100 characters
companyId
integer <int32>
contactId
integer <int32>
jobDescription
string
statusId
integer <int32>

Job status

userFavourite
boolean

Job is a favourite for the current user

object (SubmitCategoryModel)
object (SubmitLocationModel)
workplaceAddressId
string <uuid>

Workplace Address Id

object (SubmitJobOrderStartModel)
object (SubmitDurationModel)
workTypeId
integer <int32>
object (SubmitJobOrderSalaryRangeModel)
object (SubmitJobOrderFeeModel)
numberOfJobs
integer <int32>
source
string <= 50 characters
Array of objects (SubmitCustomFieldValueModel)
object (SubmitJobOrderSkillTagsModel)
ownerUserId
integer <int32>

User Id - Owner of this job

recruiterUserId
Array of integers <int32>

User Id - Optional list of recruiters assigned to the job

Responses

Request samples

Content type
application/json
{
  • "jobTitle": "string",
  • "companyId": 0,
  • "contactId": 0,
  • "jobDescription": "string",
  • "statusId": 0,
  • "userFavourite": true,
  • "category": {
    },
  • "location": {
    },
  • "workplaceAddressId": "00000000-0000-0000-0000-000000000000",
  • "start": {
    },
  • "duration": {
    },
  • "workTypeId": 0,
  • "salary": {
    },
  • "fee": {
    },
  • "numberOfJobs": 0,
  • "source": "string",
  • "custom": [
    ],
  • "skillTags": {
    },
  • "ownerUserId": 0,
  • "recruiterUserId": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Set a job status

Change the job status and add an optional note

Authorizations:
jobadder_identity (writewrite_job)
path Parameters
jobId
required
integer <int32>
Request Body schema: application/json
statusId
required
integer <int32>

Status Id

object (SubmitStatusNoteModel)

Optional note

Responses

Request samples

Content type
application/json
{
  • "statusId": 0,
  • "note": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Recently deleted jobs

Provides a list of jobs recently (last 14 days) deleted from JobAdder.

Authorizations:
jobadder_identity (readread_job)

Responses

Response Schema: application/json
Array of objects (DeletedJobOrderModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Job Applications

Get job applications

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
jobId
required
integer <int32>

Job Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32>

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add candidates to a job

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
jobId
required
integer <int32>
Request Body schema: application/json
candidateId
required
Array of integers <int32>
source
string

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Request samples

Content type
application/json
{
  • "candidateId": [
    ],
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get active job applications

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
jobId
required
integer <int32>

Job Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32>

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Submit a candidate to an evergreen job

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
jobId
required
integer <int32>
Request Body schema: application/json
source
string
firstName
required
string <= 50 characters
lastName
required
string <= 50 characters
salutation
string
email
required
string <= 100 characters
phone
string <= 50 characters
mobile
string <= 50 characters
object (SubmitAddressModel)
object
object (SubmitEmploymentModel)
object (SubmitCandidateAvailabilityModel)

The date the candidate is available to start. Specify ONE OF immediate, relative or date.

Array of objects (SubmitCandidateEducationModel)
skillTags
Array of strings
object (SubmitScreeningQuesionResultsModel)
object (SubmitJobApplicationCustomFieldsModel)

Candidate and job application custom field values

Responses

Response Schema: application/json
applicationId
required
integer <int64>
jobTitle
string
jobReference
string
manual
boolean
source
string
rating
integer <int32>
object (JobApplicationStatusModel)
object (JobApplicationReviewModel)
object (CandidateNameModel)
object (JobOrderTitleModel)
object (JobAdSummaryModel)
object (JobApplicationSubmittedDetailsModel)
object (JobApplicationScreeningModel)
Array of objects (CustomFieldValueModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (JobApplicationLinks)

Request samples

Content type
application/json
{
  • "source": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "salutation": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "address": {
    },
  • "social": {},
  • "employment": {
    },
  • "availability": {
    },
  • "education": [
    ],
  • "skillTags": [
    ],
  • "screening": {
    },
  • "custom": {
    }
}

Response samples

Content type
application/json
{
  • "applicationId": 0,
  • "jobTitle": "string",
  • "jobReference": "string",
  • "manual": true,
  • "source": "string",
  • "rating": 0,
  • "status": {
    },
  • "review": {
    },
  • "candidate": {
    },
  • "job": {
    },
  • "jobAd": {
    },
  • "submittedDetails": {
    },
  • "screening": {
    },
  • "custom": [
    ],
  • "partnerActions": [
    ],
  • "owner": {
    },
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Attachments

Find attachments

Authorizations:
jobadder_identity (readread_job)
path Parameters
jobId
required
integer <int32>
query Parameters
type
Array of strings
Items Enum: "Other" "JobDescription"

Attachment types to include

latest
boolean

Find the latest version of each attachment type

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobOrderAttachmentModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get an attachment

Get a job attachment.
Setting the Accept header will attempt a file conversion.

Authorizations:
jobadder_identity (readread_job)
path Parameters
jobId
required
integer <int32>

Job Id

attach
required
integer <int64>

Attachment Id

Responses

Response Schema:
application/octet-stream
application/octet-stream
application/pdf
text/html
text/plain
string <binary>

Update attachment details

Authorizations:
jobadder_identity (writewrite_job)
path Parameters
jobId
required
integer <int32>

Job Id

attach
required
integer <int64>

Attachment Id

Request Body schema: application/json
type
string
Enum: "Other" "JobDescription"

Attachment type

category
string

Optional additional categorization for the attachment type

expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

Responses

Request samples

Content type
application/json
{
  • "type": "Other",
  • "category": "string",
  • "expiry": "2019-08-24"
}

Add a single attachment

Authorizations:
jobadder_identity (writewrite_job)
path Parameters
jobId
required
integer <int32>

Job Id

attach
required
string
Enum: "Other" "JobDescription"
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Response Schema: application/json
attachmentId
integer <int64>
type
string
Enum: "Other" "JobDescription"
category
string
fileName
string
fileType
string
expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

object (UserNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (JobOrderAttachmentLinks)

Response samples

Content type
application/json
{
  • "attachmentId": 0,
  • "type": "Other",
  • "category": "string",
  • "fileName": "string",
  • "fileType": "string",
  • "expiry": "2019-08-24",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Get all attachment categories

Authorizations:
jobadder_identity (readread_job)
query Parameters
type
Array of strings
Items Enum: "Other" "JobDescription"

Optionally filter to specific attachment types

Responses

Response Schema: application/json
Array of objects (JobOrderAttachmentCategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Submissions

Get all submissions

path Parameters
jobId
required
integer <int32>

Job Id

Responses

Response Schema: application/json
Array of objects (SubmissionSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Placements

Get all placements

path Parameters
jobId
required
integer <int32>

Job Id

Responses

Response Schema: application/json
Array of objects (PlacementSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get approved placements

path Parameters
jobId
required
integer <int32>

Job Id

Responses

Response Schema: application/json
Array of objects (PlacementSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Notes

Get job notes

Authorizations:
jobadder_identity (readread_noteread_job_note)
path Parameters
jobId
required
integer <int32>

Job Id

query Parameters
noteId
Array of strings <uuid>

Note Id

type
Array of strings

Note type

reference
Array of strings

Reference value used to identify a note or group of notes

createdAt
Array of strings

Search for notes created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for notes updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: type, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: text

Responses

Response Schema: application/json
Array of objects (NoteSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a note

Authorizations:
jobadder_identity (writewrite_notewrite_job_note)
path Parameters
jobId
required
integer <int32>
Request Body schema: application/json
type
string <= 50 characters

Note type

text
required
string

Note content

applicationId
Array of integers <int64>
reference
string <= 200 characters

Optional reference string used to identify a note or group of notes

object (SubmitUserModel)

The user creating the note if not the authenticated user.
Specify either userId or email.

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string",
  • "applicationId": [
    ],
  • "reference": "string",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get all note types

Authorizations:
jobadder_identity (readread_noteread_job_note)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NoteTypeModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Activities

Get job activities

Authorizations:
jobadder_identity (readread_job)
path Parameters
jobId
required
integer <int32>

Job Id

Responses

Response Schema: application/json
Array of objects (JobOrderActivitySummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add a job activity

Authorizations:
jobadder_identity (writewrite_job)
path Parameters
jobId
required
integer <int32>

Job Id

Request Body schema: application/json
activitySettingId
integer <int32>
statusId
integer <int32>
object (ActivityAnswerListModel)

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
jobId
integer <int32>

Request samples

Content type
application/json
{
  • "activitySettingId": 0,
  • "statusId": 0,
  • "answers": {
    }
}

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "jobId": 0
}

Get a job activity

Authorizations:
jobadder_identity (readread_job)
path Parameters
jobId
required
integer <int32>

Job Id

activityId
required
integer <int64>

Activity Id

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
jobId
integer <int32>
object (ModelLinks)

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "jobId": 0,
  • "links": {
    }
}

Find job activities

Authorizations:
jobadder_identity (readread_job)
query Parameters
createdAt
Array of strings

Search for activities performed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

includeDetails
boolean
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobOrderActivityModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all job activity settings definitions

Authorizations:
jobadder_identity (readread_job)

Responses

Response Schema: application/json
Array of objects (JobOrderActivitySettingSummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get job activity setting with details

Authorizations:
jobadder_identity (readread_job)
path Parameters
settingId
required
integer <int32>

Activity Setting Id

Responses

Response Schema: application/json
settingId
integer <int32>
activityType
string
name
string
Array of objects (StatusModel)
statusMandatory
boolean
Array of objects (ActivityQuestionModel)

Response samples

Content type
application/json
{
  • "settingId": 0,
  • "activityType": "string",
  • "name": "string",
  • "validStatuses": [
    ],
  • "statusMandatory": true,
  • "questions": [
    ]
}

Lists

Get all custom fields

Authorizations:
jobadder_identity (readread_job)

Responses

Response Schema: application/json
Array of objects (CustomFieldModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a custom field

Authorizations:
jobadder_identity (readread_job)
path Parameters
fieldId
required
integer <int32>

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Modify custom field list values

Authorizations:
jobadder_identity (manage_job_custom)
path Parameters
fieldId
required
integer <int32>
Request Body schema: application/json
values
Array of strings

Available values for a list custom field

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Request samples

Content type
application/json
{
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Get all job sources

query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all status definitions

query Parameters
statusId
Array of integers <int32>
name
string
active
boolean
default
boolean

Responses

Response Schema: application/json
Array of objects (StatusModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a status definition

path Parameters
statusId
required
integer <int32>

Responses

Response Schema: application/json
statusId
required
integer <int32>
name
required
string
active
boolean
default
boolean
object (ModelLinks)

Response samples

Content type
application/json
{
  • "statusId": 0,
  • "name": "string",
  • "active": true,
  • "default": true,
  • "links": {
    }
}

Requisitions

Find requisitions

Authorizations:
jobadder_identity (readread_requisition)
query Parameters
requisitionId
Array of integers <int32>

Requisition Id

companyId
Array of integers <int32>

Company Id

status
Array of strings
Items Enum: "Draft" "Submitted" "Rejected" "Approved"
hiringManager.contactId
Array of integers <int32>
hiringManager.name
string
approver.contactId
Array of integers <int32>

Find requisitions by approver contact id

approver.name
string
approver.pending
boolean

Find requisitions pending approval by contacts specified in approver.contactId

userId
Array of integers <int32>

User Id - search for requisitions by owner or associated recruiter

ownerUserId
Array of integers <int32>

User Id - search for requisitions by owner

recruiterUserId
Array of integers <int32>

User Id - search for requisitions by associated recruiters

createdAt
Array of strings

Search for jobs created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for jobs updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: jobTitle, status, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: workflow

embed
Array of strings

Linked resources to embed in the results
Resources available are: self, notes

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (RequisitionSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a requisition

Authorizations:
jobadder_identity (writewrite_requisition)
Request Body schema: application/json
contactId
required
integer <int32>

Hiring manager (contact) submitting the requisition.

jobTitle
required
string [ 0 .. 100 ] characters
jobDescription
string
object (SubmitCategoryModel)
object (SubmitLocationModel)
workplaceAddressId
string <uuid>

Workplace address Id

object (SubmitJobOrderStartModel)
object (SubmitDurationModel)
workTypeId
integer <int32>
object (SubmitJobOrderSalaryRangeModel)
numberOfJobs
integer <int32>
source
string [ 0 .. 100 ] characters
Array of objects (SubmitCustomFieldValueModel)
workflowId
integer <int32>
recruiterUserId
Array of integers <int32>

User Id - Optional list of recruiters assigned to the requisition.

Responses

Response Schema: application/json
requisitionId
required
integer <int32>
status
string
Enum: "Draft" "Submitted" "Rejected" "Approved"
workflowStageIndex
integer <int32>
jobTitle
required
string
object (CompanyNameModel)
object (ContactNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (CompanyWorkflowModel)
jobDescription
string
numberOfJobs
integer <int32>
source
string

Source of the requisition, or reason the requisition is being raised.

object (CompanyAddressModel)
object (JobOrderCategoryModel)
object (JobOrderLocationModel)
object (JobOrderStartModel)
object (DurationModel)
object (WorkTypeModel)
object (JobOrderSalaryRangeModel)
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (UserNameModel)
object (RequisitionLinks)

Request samples

Content type
application/json
{
  • "contactId": 0,
  • "jobTitle": "string",
  • "jobDescription": "string",
  • "category": {
    },
  • "location": {
    },
  • "workplaceAddressId": "00000000-0000-0000-0000-000000000000",
  • "start": {
    },
  • "duration": {
    },
  • "workTypeId": 0,
  • "salary": {
    },
  • "numberOfJobs": 0,
  • "source": "string",
  • "custom": [
    ],
  • "workflowId": 0,
  • "recruiterUserId": [
    ]
}

Response samples

Content type
application/json
{
  • "requisitionId": 0,
  • "status": "Draft",
  • "workflowStageIndex": 0,
  • "jobTitle": "string",
  • "company": {
    },
  • "hiringManager": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "workflow": {
    },
  • "jobDescription": "string",
  • "numberOfJobs": 0,
  • "source": "string",
  • "workplaceAddress": {
    },
  • "category": {
    },
  • "location": {
    },
  • "start": {
    },
  • "duration": {
    },
  • "workType": {
    },
  • "salary": {
    },
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "links": {
    }
}

Get a requisition

Authorizations:
jobadder_identity (readread_requisition)
path Parameters
requisitionId
required
integer <int32>

Requisition Id

query Parameters
embed
Array of strings

Embed related resources.
Resources available to embed are: notes

Responses

Response Schema: application/json
requisitionId
required
integer <int32>
status
string
Enum: "Draft" "Submitted" "Rejected" "Approved"
workflowStageIndex
integer <int32>
jobTitle
required
string
object (CompanyNameModel)
object (ContactNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (CompanyWorkflowModel)
jobDescription
string
numberOfJobs
integer <int32>
source
string

Source of the requisition, or reason the requisition is being raised.

object (CompanyAddressModel)
object (JobOrderCategoryModel)
object (JobOrderLocationModel)
object (JobOrderStartModel)
object (DurationModel)
object (WorkTypeModel)
object (JobOrderSalaryRangeModel)
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (UserNameModel)
object (RequisitionLinks)

Response samples

Content type
application/json
{
  • "requisitionId": 0,
  • "status": "Draft",
  • "workflowStageIndex": 0,
  • "jobTitle": "string",
  • "company": {
    },
  • "hiringManager": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "workflow": {
    },
  • "jobDescription": "string",
  • "numberOfJobs": 0,
  • "source": "string",
  • "workplaceAddress": {
    },
  • "category": {
    },
  • "location": {
    },
  • "start": {
    },
  • "duration": {
    },
  • "workType": {
    },
  • "salary": {
    },
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "links": {
    }
}

Update a requisition

Authorizations:
jobadder_identity (writewrite_requisition)
path Parameters
requisitionId
required
integer <int32>

Requisition Id

Request Body schema: application/json
contactId
integer <int32>

Optional contact associated with the change, must be associated with the same company as the requisition.

jobTitle
required
string [ 0 .. 100 ] characters
jobDescription
string
object (SubmitCategoryModel)
object (SubmitLocationModel)
workplaceAddressId
string <uuid>

Workplace address Id

object (SubmitJobOrderStartModel)
object (SubmitDurationModel)
workTypeId
integer <int32>
object (SubmitJobOrderSalaryRangeModel)
numberOfJobs
integer <int32>
source
string [ 0 .. 100 ] characters
Array of objects (SubmitCustomFieldValueModel)
workflowId
integer <int32>
recruiterUserId
Array of integers <int32>

User Id - Optional list of recruiters assigned to the requisition.

Responses

Request samples

Content type
application/json
{
  • "contactId": 0,
  • "jobTitle": "string",
  • "jobDescription": "string",
  • "category": {
    },
  • "location": {
    },
  • "workplaceAddressId": "00000000-0000-0000-0000-000000000000",
  • "start": {
    },
  • "duration": {
    },
  • "workTypeId": 0,
  • "salary": {
    },
  • "numberOfJobs": 0,
  • "source": "string",
  • "custom": [
    ],
  • "workflowId": 0,
  • "recruiterUserId": [
    ]
}

Remove a requisition

Authorizations:
jobadder_identity (writewrite_requisition)
path Parameters
requisitionId
required
integer <int32>

Responses

Attachments

Get an attachment

Authorizations:
jobadder_identity (readread_requisition)
path Parameters
requisitionId
required
integer <int32>

Requisition Id

attachmentType
required
string
Enum: "Other" "JobDescription"

Responses

Response Schema: application/octet-stream
string <binary>

Add an attachment

Authorizations:
jobadder_identity (writewrite_requisition)
path Parameters
requisitionId
required
integer <int32>

Requisition Id

attachmentType
required
string
Enum: "Other" "JobDescription"
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Remove an attachment

Authorizations:
jobadder_identity (writewrite_requisition)
path Parameters
requisitionId
required
integer <int32>

Requisition Id

attachmentType
required
string
Enum: "Other" "JobDescription"

Responses

Approval

Approve a requisition

Authorizations:
jobadder_identity (writewrite_requisition)
path Parameters
requisitionId
required
integer <int32>
Request Body schema: application/json
approverId
required
integer <int32>
message
string

Responses

Request samples

Content type
application/json
{
  • "approverId": 0,
  • "message": "string"
}

Get approval history

Authorizations:
jobadder_identity (readread_requisition)
path Parameters
requisitionId
required
integer <int32>

Requisition Id

query Parameters
offset
integer <int32>
limit
integer <int32>

Responses

Response Schema: application/json
Array of objects (RequisitionLogModel)
totalCount
required
integer <int32>

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0
}

Reject a requisition

Authorizations:
jobadder_identity (writewrite_requisition)
path Parameters
requisitionId
required
integer <int32>
Request Body schema: application/json
approverId
required
integer <int32>
reason
string

Responses

Request samples

Content type
application/json
{
  • "approverId": 0,
  • "reason": "string"
}

Submit a requisition for approval

Authorizations:
jobadder_identity (writewrite_requisition)
path Parameters
requisitionId
required
integer <int32>
Request Body schema: application/json
object (SubmitRequisitionCommand)

Responses

Request samples

Content type
application/json
{ }

Notes

Get requisition notes

Authorizations:
jobadder_identity (readread_noteread_requisition_note)
path Parameters
requisitionId
required
integer <int32>

Requisition Id

query Parameters
noteId
Array of strings <uuid>

Note Id

type
Array of strings

Note type

reference
Array of strings

Reference value used to identify a note or group of notes

createdAt
Array of strings

Search for notes created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for notes updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: type, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: text

Responses

Response Schema: application/json
Array of objects (NoteSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a requisition note

Authorizations:
jobadder_identity (writewrite_notewrite_requisition_note)
path Parameters
requisitionId
required
integer <int32>
Request Body schema: application/json
type
string <= 50 characters

Note type

text
required
string

Note content

reference
string <= 200 characters

Optional reference string used to identify a note or group of notes

object (SubmitUserModel)

The user creating the note if not the authenticated user.
Specify either userId or email.

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string",
  • "reference": "string",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Lists

Get all custom fields

Authorizations:
jobadder_identity (readread_requisition)

Responses

Response Schema: application/json
Array of objects (CustomFieldModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a custom field

Authorizations:
jobadder_identity (readread_requisition)
path Parameters
fieldId
required
integer <int32>

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Job Ads

Find job ads

Authorizations:
jobadder_identity (readread_jobad)
query Parameters
partnerAction.actionId
Array of strings <uuid>

Unique identifier for partner actions

partnerAction.reference
Array of strings

Partner supplied unique reference for the action

partnerAction.stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

partnerAction.submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

fields
Array of strings

Additional fields to include with the results. Fields available to include are: self,applications,partnerActions

embed
Array of strings

Embed related resources.
Resources available to embed are: self, applications

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobAdSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a draft job ad

Authorizations:
jobadder_identity (writewrite_jobad)
Request Body schema: application/json
title
required
string
reference
string
summary
string
bulletPoints
Array of strings
description
string
jobId
integer <int32>

Associated job

ownerUserId
required
integer <int32>

Responses

Response Schema: application/json
adId
required
integer <int32>
state
string
title
string
reference
string
summary
string
bulletPoints
Array of strings
description
string
object (JobOrderTitleModel)
object (CompanyNameModel)
object (ContactNameModel)
Array of objects (JobAdScreeningQuestionModel)
Array of objects (JobBoardSummaryModel)
object (UserNameModel)
object (UserNameModel)
createdAt
string <date-time>
postAt
string <date-time>
expireAt
string <date-time>
Array of objects (PartnerActionStageModel)
object (JobAdLinks)

Request samples

Content type
application/json
{
  • "title": "string",
  • "reference": "string",
  • "summary": "string",
  • "bulletPoints": [
    ],
  • "description": "string",
  • "jobId": 0,
  • "ownerUserId": 0
}

Response samples

Content type
application/json
{
  • "adId": 0,
  • "state": "string",
  • "title": "string",
  • "reference": "string",
  • "summary": "string",
  • "bulletPoints": [
    ],
  • "description": "string",
  • "job": {
    },
  • "company": {
    },
  • "contact": {
    },
  • "screening": [
    ],
  • "jobBoards": [
    ],
  • "owner": {
    },
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "postAt": "2019-08-24T14:15:22Z",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "partnerActions": [
    ],
  • "links": {
    }
}

Get a job ad

Authorizations:
jobadder_identity (readread_jobad)
path Parameters
adId
required
integer <int32>

Job Ad Id

query Parameters
embed
Array of strings

Embed related resources.
Resources available to embed are: applications

Responses

Response Schema: application/json
adId
required
integer <int32>
state
string
title
string
reference
string
summary
string
bulletPoints
Array of strings
description
string
object (JobOrderTitleModel)
object (CompanyNameModel)
object (ContactNameModel)
Array of objects (JobAdScreeningQuestionModel)
Array of objects (JobBoardSummaryModel)
object (UserNameModel)
object (UserNameModel)
createdAt
string <date-time>
postAt
string <date-time>
expireAt
string <date-time>
Array of objects (PartnerActionStageModel)
object (JobAdLinks)

Response samples

Content type
application/json
{
  • "adId": 0,
  • "state": "string",
  • "title": "string",
  • "reference": "string",
  • "summary": "string",
  • "bulletPoints": [
    ],
  • "description": "string",
  • "job": {
    },
  • "company": {
    },
  • "contact": {
    },
  • "screening": [
    ],
  • "jobBoards": [
    ],
  • "owner": {
    },
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "postAt": "2019-08-24T14:15:22Z",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "partnerActions": [
    ],
  • "links": {
    }
}

Update a draft job ad

Authorizations:
jobadder_identity (writewrite_jobad)
path Parameters
adId
required
integer <int32>
Request Body schema: application/json
title
string
reference
string
summary
string
bulletPoints
Array of strings
description
string
jobId
integer <int32>

Associated job

ownerUserId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "reference": "string",
  • "summary": "string",
  • "bulletPoints": [
    ],
  • "description": "string",
  • "jobId": 0,
  • "ownerUserId": 0
}

Job Applications

Get job applications

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
adId
required
integer <int32>

Job Ad Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get active job applications

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
adId
required
integer <int32>

Job Ad Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Candidates

Find candidates

Authorizations:
jobadder_identity (readread_candidate)
query Parameters
candidateId
Array of integers <int32>

Candidate Id

name
string

Candidate name

email
string

Candidate email

phone
string

Candidate phone or mobile number

currentPosition
string

Current Position

city
string

City

state
string

State

keywords
string

Search for key-words within the latest candidate resume

partnerAction.actionId
Array of strings <uuid>

Unique identifier for partner actions

partnerAction.reference
Array of strings

Partner supplied unique reference for the action

partnerAction.stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

partnerAction.submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

statusId
Array of integers <int32>

Candidate status

recruiterUserId
Array of integers <int32>

User Id - search candidates by associated recruiters

folderId
Array of integers <int64>

Search in specific folders

createdAt
Array of strings

Search for candidates created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for candidates updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: firstName, lastName, status.name, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results. Fields available to include are: recruiters, statistics

embed
Array of strings

Embed related resources.
Resources available to embed are: self, applications, placements, skills, notes

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CandidateSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a candidate

Authorizations:
jobadder_identity (writewrite_candidate)
header Parameters
X-Allow-Duplicates
string

Duplicate override code from the header of an earlier 409 response

Request Body schema: application/json
firstName
string <= 50 characters
lastName
string <= 50 characters
email
string <= 100 characters
phone
string <= 50 characters
mobile
string <= 50 characters
salutation
string <= 20 characters

Salutation/honorific/title

statusId
integer <int32>

Candidate status

rating
string <= 50 characters
source
string <= 50 characters

Candidate source

seeking
string
Enum: "Yes" "Maybe" "No"
summary
string
object
object (SubmitAddressModel)
skillTags
Array of strings <= 100 characters
object (SubmitEmploymentModel)
object (SubmitCandidateAvailabilityModel)

The date the candidate is available to start. Specify ONE OF immediate, relative or date.

Array of objects (SubmitCandidateEducationModel)
Array of objects (SubmitCustomFieldValueModel)
recruiterUserId
Array of integers <int32>

Responses

Response Schema: application/json
candidateId
required
integer <int32>

Candidate Id

firstName
string

First name

lastName
string

Last name

email
string

Primary email address

phone
string

Contact phone number

mobile
string

Mobile/cell number

contactMethod
string

Preferred contact method

salutation
string

Salutation/honorific/title

object (AddressModel)
object (StatusModel)
rating
string

Internal rating of the candidate

source
string

The source of the candidate

seeking
string
Enum: "Yes" "Maybe" "No"

Indicates whether or not the candidate is actively seeking a job.

otherEmail
Array of strings

Other email addresses used by the candidate

object

Candidate social profiles

summary
string
object (CandidateEmploymentModel)
object (CandidateStartModel)

The date the candidate is available to start. Specify ONE OF immediate, relative or date.

Array of objects (CandidateEducationModel)
skillTags
Array of strings
Array of objects (CustomFieldValueModel)
Array of objects (UserNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
Array of objects (PartnerActionStageModel)
object (CandidateStatisticsModel)
object (CandidateLinks)

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "salutation": "string",
  • "statusId": 0,
  • "rating": "string",
  • "source": "string",
  • "seeking": "Yes",
  • "summary": "string",
  • "social": {},
  • "address": {
    },
  • "skillTags": [
    ],
  • "employment": {
    },
  • "availability": {
    },
  • "education": [
    ],
  • "custom": [
    ],
  • "recruiterUserId": [
    ]
}

Response samples

Content type
application/json
{
  • "candidateId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "contactMethod": "string",
  • "salutation": "string",
  • "address": {
    },
  • "status": {
    },
  • "rating": "string",
  • "source": "string",
  • "seeking": "Yes",
  • "otherEmail": [
    ],
  • "social": {},
  • "summary": "string",
  • "employment": {
    },
  • "availability": {
    },
  • "education": [
    ],
  • "skillTags": [
    ],
  • "custom": [
    ],
  • "recruiters": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "partnerActions": [
    ],
  • "statistics": {
    },
  • "links": {
    }
}

Get a candidate

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

query Parameters
embed
Array of strings

Embed related resources.
Resources available to embed are: skills, notes, applications, placements

Responses

Response Schema: application/json
candidateId
required
integer <int32>

Candidate Id

firstName
string

First name

lastName
string

Last name

email
string

Primary email address

phone
string

Contact phone number

mobile
string

Mobile/cell number

contactMethod
string

Preferred contact method

salutation
string

Salutation/honorific/title

object (AddressModel)
object (StatusModel)
rating
string

Internal rating of the candidate

source
string

The source of the candidate

seeking
string
Enum: "Yes" "Maybe" "No"

Indicates whether or not the candidate is actively seeking a job.

otherEmail
Array of strings

Other email addresses used by the candidate

object

Candidate social profiles

summary
string
object (CandidateEmploymentModel)
object (CandidateStartModel)

The date the candidate is available to start. Specify ONE OF immediate, relative or date.

Array of objects (CandidateEducationModel)
skillTags
Array of strings
Array of objects (CustomFieldValueModel)
Array of objects (UserNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
Array of objects (PartnerActionStageModel)
object (CandidateStatisticsModel)
object (CandidateLinks)

Response samples

Content type
application/json
{
  • "candidateId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "contactMethod": "string",
  • "salutation": "string",
  • "address": {
    },
  • "status": {
    },
  • "rating": "string",
  • "source": "string",
  • "seeking": "Yes",
  • "otherEmail": [
    ],
  • "social": {},
  • "summary": "string",
  • "employment": {
    },
  • "availability": {
    },
  • "education": [
    ],
  • "skillTags": [
    ],
  • "custom": [
    ],
  • "recruiters": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "partnerActions": [
    ],
  • "statistics": {
    },
  • "links": {
    }
}

Update a candidate

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>
header Parameters
X-Allow-Duplicates
string

Duplicate override code from the header of an earlier 409 response

Request Body schema: application/json
firstName
string <= 50 characters
lastName
string <= 50 characters
email
string <= 100 characters
phone
string <= 50 characters
mobile
string <= 50 characters
salutation
string <= 20 characters

Salutation/honorific/title

statusId
integer <int32>

Candidate status

rating
string <= 50 characters
seeking
string
Enum: "Yes" "Maybe" "No"
summary
string
object
object (SubmitAddressModel)
skillTags
Array of strings <= 100 characters
object (SubmitEmploymentModel)
object (SubmitCandidateAvailabilityModel)

The date the candidate is available to start. Specify ONE OF immediate, relative or date.

Array of objects (SubmitCandidateEducationModel)
Array of objects (SubmitCustomFieldValueModel)
recruiterUserId
Array of integers <int32>

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "salutation": "string",
  • "statusId": 0,
  • "rating": "string",
  • "seeking": "Yes",
  • "summary": "string",
  • "social": {},
  • "address": {
    },
  • "skillTags": [
    ],
  • "employment": {
    },
  • "availability": {
    },
  • "education": [
    ],
  • "custom": [
    ],
  • "recruiterUserId": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Set a candidate status

Change the candidate status and add an optional note

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>
Request Body schema: application/json
statusId
required
integer <int32>

Status Id

object (SubmitStatusNoteModel)

Optional note

Responses

Request samples

Content type
application/json
{
  • "statusId": 0,
  • "note": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Recently deleted candidates

Provides a list of candidates recently (last 14 days) deleted from JobAdder, allowing the management of referenced data for local privacy law compliance (e.g. GDPR).

Authorizations:
jobadder_identity (readread_candidate)

Responses

Response Schema: application/json
Array of objects (DeletedCandidateModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Photo

Get a photo

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

query Parameters
w
integer <int32>

Reduce the size of the photo to fit the width specified by w

h
integer <int32>

Reduce the size of the photo to fit the height specified by h

Responses

Response Headers
ETag
string

Photo version, can be used for cache validation

Response Schema:
image/jpeg
image/jpeg
image/gif
image/png
string <binary>

Update a photo

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Remove a photo

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Responses

Get photo headers

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

query Parameters
w
integer <int32>

Reduce the size of the photo to fit the width specified by w

h
integer <int32>

Reduce the size of the photo to fit the height specified by h

Responses

Response Headers
ETag
string

Photo version, can be used for cache validation

Availability

Get availability

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Responses

Response Schema: application/json
Array of objects (CandidateAvailabilityModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Update weekly availability

Set the candidates availability schedule for a single week

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Request Body schema: application/json
weekOf
required
string <date>

Update availability for the week (beginning Sunday) containing the specified date

required
object

Weekly availability, at most two shifts per day

recurring
boolean

Availability repeats in following weeks. Previous/past recurring schedules will be terminated prior to this schedule, existing future overlapping schedules will be cancelled.

until
string <date>

Optional end date of repeating availability

Responses

Request samples

Content type
application/json
{
  • "weekOf": "2019-08-24",
  • "availability": {
    },
  • "recurring": true,
  • "until": "2019-08-24"
}

Remove weekly availability

Remove the candidates availability schedule for a single week

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

query Parameters
weekOf
required
string <date>

Remove availability for the week (beginning Sunday) containing the specified date

recurring
boolean

Remove availability in following weeks. Previous/past recurring schedules will be terminated prior to this schedule, all existing future overlapping schedules will be cancelled.

until
string <date>

Optional end date of repeating availability removal

Responses

Videos

Get all videos

path Parameters
candidateId
required
integer <int32>

Responses

Response Schema: application/json
Array of objects (CandidateVideoModel)
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a recent video

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>
videoType
required
string
Enum: "Other" "Profile" "CoverLetter"

Responses

Response Schema: application/json
type
required
string
Enum: "Other" "Profile" "CoverLetter"
url
string

Video URL

reference
string

Optional unique reference for this video type.

createdAt
string <date-time>

Date this video was added to the candidate

updatedAt
string <date-time>

Date this video was last updated (updates are possible when a video is added with a Reference)

Response samples

Content type
application/json
{
  • "type": "Other",
  • "url": "string",
  • "reference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Add a video

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

videoType
required
string
Enum: "Other" "Profile" "CoverLetter"
Request Body schema: application/json
url
required
string

Video URL

reference
string

Optional unique reference for this video type, if specified then an existing video with the same type and reference will be updated if found.

Responses

Response Schema: application/json
type
required
string
Enum: "Other" "Profile" "CoverLetter"
url
string

Video URL

reference
string

Optional unique reference for this video type.

createdAt
string <date-time>

Date this video was added to the candidate

updatedAt
string <date-time>

Date this video was last updated (updates are possible when a video is added with a Reference)

Request samples

Content type
application/json
{
  • "url": "string",
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "type": "Other",
  • "url": "string",
  • "reference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Skills

Get skills

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>

Responses

Response Schema: application/json
Array of objects (CategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Update skills

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>
Request Body schema: application/json
Array of objects (SubmitCategoriesModel)

Skill categories to update for this candidate.
Only skills and sub-categories for the submitted categories will be modified.

Responses

Response Schema: application/json
Array of objects (CategoryModel)
object (ModelLinks)

Request samples

Content type
application/json
{
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Remove skills

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>
Request Body schema: application/json
Array of objects (RemoveCategoriesModel)

Skill categories to remove from this candidate.

Responses

Response Schema: application/json
Array of objects (CategoryModel)
object (ModelLinks)

Request samples

Content type
application/json
{
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Remove a category

Remove a single category and all associated sub-categories and skills

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>
categoryId
required
integer <int32>

Responses

Response Schema: application/json
Array of objects (CategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Attachments

Find attachments

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>
query Parameters
type
Array of strings
Items Enum: "Other" "Resume" "CoverLetter" "FormattedResume" "Screening" "Check" "Reference" "License"

Attachment types to include

category
Array of strings

Search by attachment category

latest
boolean

Find the latest version of each attachment type

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CandidateAttachmentModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get an attachment

Get a candidate attachment.
Setting the Accept header will attempt a file conversion.

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

attach
required
integer <int64>

Attachment Id

Responses

Response Schema:
application/octet-stream
application/octet-stream
application/pdf
text/html
text/plain
string <binary>

Update attachment details

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

attach
required
integer <int64>

Attachment Id

Request Body schema: application/json
type
string
Enum: "Other" "Resume" "CoverLetter" "FormattedResume" "Screening" "Check" "Reference" "License"

Attachment type

category
string

Optional additional categorization for the attachment type

expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

Responses

Response Schema: application/json
attachmentId
integer <int64>
type
string
Enum: "Other" "Resume" "CoverLetter" "FormattedResume" "Screening" "Check" "Reference" "License"
category
string
fileName
string
fileType
string
expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

object (UserNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (CandidateAttachmentLinks)

Request samples

Content type
application/json
{
  • "type": "Other",
  • "category": "string",
  • "expiry": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "attachmentId": 0,
  • "type": "Other",
  • "category": "string",
  • "fileName": "string",
  • "fileType": "string",
  • "expiry": "2019-08-24",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Add a single attachment

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

attach
required
string
Enum: "Resume" "FormattedResume" "CoverLetter" "Screening" "Check" "Reference" "License" "Other"

Type of attachment being added

Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Response Schema: application/json
attachmentId
integer <int64>
type
string
Enum: "Other" "Resume" "CoverLetter" "FormattedResume" "Screening" "Check" "Reference" "License"
category
string
fileName
string
fileType
string
expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

object (UserNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (CandidateAttachmentLinks)

Response samples

Content type
application/json
{
  • "attachmentId": 0,
  • "type": "Other",
  • "category": "string",
  • "fileName": "string",
  • "fileType": "string",
  • "expiry": "2019-08-24",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Get all attachment categories

Authorizations:
jobadder_identity (readread_candidate)
query Parameters
type
Array of strings
Items Enum: "Other" "Resume" "CoverLetter" "FormattedResume" "Screening" "Check" "Reference" "License"

Optionally filter to specific attachment types

Responses

Response Schema: application/json
Array of objects (CandidateAttachmentCategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Floats

Get all floats

Authorizations:
jobadder_identity (readread_float)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Responses

Response Schema: application/json
Array of objects (FloatSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Job Applications

Get job applications

This will include both active and complete/closed job applications

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
candidateId
required
integer <int32>

Candidate Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32>

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add jobs to a candidate

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
candidateId
required
integer <int32>
Request Body schema: application/json
jobId
required
Array of integers <int32>
source
string

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Request samples

Content type
application/json
{
  • "jobId": [
    ],
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get active job applications

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
candidateId
required
integer <int32>

Candidate Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32>

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Interviews

Get all Interviews

Authorizations:
jobadder_identity (readread_interview)
path Parameters
candidateId
required
integer <int32>

Candidate Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (InterviewSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Submissions

Get all submissions

Authorizations:
jobadder_identity (readread_submission)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Responses

Response Schema: application/json
Array of objects (SubmissionSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Placements

Get all placements

Authorizations:
jobadder_identity (readread_placement)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Responses

Response Schema: application/json
Array of objects (PlacementSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all approved placements

Authorizations:
jobadder_identity (readread_placement)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Responses

Response Schema: application/json
Array of objects (PlacementSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Notes

Get candidate notes

Authorizations:
jobadder_identity (readread_noteread_candidate_note)
path Parameters
candidateId
required
integer <int32>

Candidate Id

query Parameters
noteId
Array of strings <uuid>

Note Id

type
Array of strings

Note type

reference
Array of strings

Reference value used to identify a note or group of notes

createdAt
Array of strings

Search for notes created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for notes updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: type, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: text

Responses

Response Schema: application/json
Array of objects (NoteSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a note

Authorizations:
jobadder_identity (writewrite_notewrite_candidate_note)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Request Body schema: application/json
type
string <= 50 characters

Note type

text
required
string

Note content

applicationId
Array of integers <int64>

Optional list of related job applications to link to the note

reference
string <= 200 characters

Optional reference string used to identify a note or group of notes

object (SubmitUserModel)

The user creating the note if not the authenticated user.
Specify either userId or email.

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string",
  • "applicationId": [
    ],
  • "reference": "string",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get all note types

Authorizations:
jobadder_identity (readread_noteread_candidate_note)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NoteTypeModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Privacy

Remove a candidate at their request

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Responses

Activities

Get candidate activities

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Responses

Response Schema: application/json
Array of objects (CandidateActivitySummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add a candidate activity

Authorizations:
jobadder_identity (writewrite_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

Request Body schema: application/json
activitySettingId
integer <int32>
statusId
integer <int32>
object (ActivityAnswerListModel)

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
candidateId
integer <int32>

Request samples

Content type
application/json
{
  • "activitySettingId": 0,
  • "statusId": 0,
  • "answers": {
    }
}

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "candidateId": 0
}

Get a candidate activity

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
candidateId
required
integer <int32>

Candidate Id

activityId
required
integer <int64>

Activity Id

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
candidateId
integer <int32>
object (ModelLinks)

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "candidateId": 0,
  • "links": {
    }
}

Find candidate activities

Authorizations:
jobadder_identity (readread_candidate)
query Parameters
createdAt
Array of strings

Search for activities performed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

includeDetails
boolean
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CandidateActivityModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all candidate activity settings definitions

Authorizations:
jobadder_identity (readread_candidate)

Responses

Response Schema: application/json
Array of objects (CandidateActivitySettingSummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get candidate activity settings with details

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
settingId
required
integer <int32>

Activity Setting Id

Responses

Response Schema: application/json
settingId
integer <int32>
activityType
string
name
string
Array of objects (StatusModel)
statusMandatory
boolean
Array of objects (ActivityQuestionModel)

Response samples

Content type
application/json
{
  • "settingId": 0,
  • "activityType": "string",
  • "name": "string",
  • "validStatuses": [
    ],
  • "statusMandatory": true,
  • "questions": [
    ]
}

Lists

Get all candidate custom field definitions

Authorizations:
jobadder_identity (readread_candidate)

Responses

Response Schema: application/json
Array of objects (CustomFieldModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a custom field definition

Authorizations:
jobadder_identity (readread_candidate)
path Parameters
fieldId
required
integer <int32>

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Modify custom field list values

Authorizations:
jobadder_identity (manage_candidate_custom)
path Parameters
fieldId
required
integer <int32>
Request Body schema: application/json
values
Array of strings

Available values for a list custom field

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Request samples

Content type
application/json
{
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Get internal ratings

Authorizations:
jobadder_identity (readread_candidate)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get salutations (honorifics/titles)

Authorizations:
jobadder_identity (readread_candidate)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all candidate sources

Authorizations:
jobadder_identity (readread_candidate)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all status definitions

Authorizations:
jobadder_identity (readread_candidate)
query Parameters
statusId
Array of integers <int32>
name
string
active
boolean
default
boolean

Responses

Response Schema: application/json
Array of objects (StatusModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a status definition

path Parameters
statusId
required
integer <int32>

Responses

Response Schema: application/json
statusId
required
integer <int32>
name
required
string
active
boolean
default
boolean
object (ModelLinks)

Response samples

Content type
application/json
{
  • "statusId": 0,
  • "name": "string",
  • "active": true,
  • "default": true,
  • "links": {
    }
}

Floats

Find floats

Authorizations:
jobadder_identity (readread_float)
query Parameters
floatId
Array of integers <int64>

Float Id

candidateId
Array of integers <int32>

Candidate Id

companyId
Array of integers <int32>

Company Id

createdAt
Array of strings

Search for floats created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for floats updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

embed
Array of strings

Embed related resources.
Resources available to embed are: self

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (FloatSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a float

Authorizations:
jobadder_identity (readread_float)
path Parameters
floatId
required
integer <int64>

Responses

Response Schema: application/json
floatId
required
integer <int64>
jobTitle
string
object (CandidateSummaryModel)
object (CompanyNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
candidateSummary
string
Array of objects (ContactNameModel)
object (UserNameModel)
object (FloatLinks)

Response samples

Content type
application/json
{
  • "floatId": 0,
  • "jobTitle": "string",
  • "candidate": {
    },
  • "company": {
    },
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "candidateSummary": "string",
  • "contacts": [
    ],
  • "owner": {
    },
  • "links": {
    }
}

Submissions

Find submissions

Authorizations:
jobadder_identity (readread_submission)
query Parameters
submissionId
Array of integers <int64>
candidateId
Array of integers <int32>
companyId
Array of integers <int32>
jobId
Array of integers <int32>
createdAt
Array of strings

Search for submissions created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for submissions updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

embed
Array of strings

Embed related resources.
Resources available to embed are: self

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (SubmissionSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a submission

Authorizations:
jobadder_identity (readread_submission)
path Parameters
submissionId
required
integer <int64>

Submission Id

Responses

Response Schema: application/json
submissionId
required
integer <int64>
jobTitle
string
object (CandidateSummaryModel)
object (CompanyNameModel)
object (JobOrderSummaryModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
candidateSummary
string
object (JobApplicationSummaryModel)
Array of objects (ContactNameModel)
object (UserNameModel)
object (SubmissionLinks)

Response samples

Content type
application/json
{
  • "submissionId": 0,
  • "jobTitle": "string",
  • "candidate": {
    },
  • "company": {
    },
  • "job": {
    },
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "candidateSummary": "string",
  • "application": {
    },
  • "contacts": [
    ],
  • "owner": {
    },
  • "links": {
    }
}

Job Applications

Find job applications

Authorizations:
jobadder_identity (readread_jobapplication)
query Parameters
applicationId
Array of integers <int64>

Application Id

candidateId
Array of integers <int32>

Candidate Id

jobId
Array of integers <int32>

Job Id

adId
Array of integers <int32>

Job Ad Id

statusId
Array of integers <int32>

Job application status

jobTitle
string
active
boolean

Search for active job applications

rejected
boolean

Search for rejected job applications

review.stage
Array of strings
Items Enum: "Submitted" "Viewed" "Accepted" "Rejected"

Search for job applications at the specified review stage.

review.userId
Array of integers <int32>

Search for job applications submitted for review by the specified users.

review.contactId
Array of integers <int32>

Search for job applications submitted for review to the specified hiring manager contacts

review.submittedAt
Array of strings

Search for job applications submitted for review at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

review.reviewedAt
Array of strings

Search for job applications reviewed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

keywords
string

Search for key words within the applicant's resume

partnerAction.actionId
Array of strings <uuid>

Unique identifier for partner actions

partnerAction.reference
Array of strings

Partner supplied unique reference for the action

partnerAction.stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

partnerAction.submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

folderId
Array of integers <int64>

Search in specific folders

createdAt
Array of strings

Search for job applications created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedBy
Array of integers <int32>

User Id - search for job applications last updated by the specified user(s)

updatedAt
Array of strings

Search for job applications updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: createdAt, status.name, review.stage, review.submittedAt, review.reviewedAt

fields
Array of strings

Additional fields to include with the results. Fields available to include are: partnerActions

embed
Array of strings

Embed related resources.
Resources available to embed are: self

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a job application

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
applicationId
required
integer <int64>

Job Application Id

Responses

Response Schema: application/json
applicationId
required
integer <int64>
jobTitle
string
jobReference
string
manual
boolean
source
string
rating
integer <int32>
object (JobApplicationStatusModel)
object (JobApplicationReviewModel)
object (CandidateNameModel)
object (JobOrderTitleModel)
object (JobAdSummaryModel)
object (JobApplicationSubmittedDetailsModel)
object (JobApplicationScreeningModel)
Array of objects (CustomFieldValueModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (JobApplicationLinks)

Response samples

Content type
application/json
{
  • "applicationId": 0,
  • "jobTitle": "string",
  • "jobReference": "string",
  • "manual": true,
  • "source": "string",
  • "rating": 0,
  • "status": {
    },
  • "review": {
    },
  • "candidate": {
    },
  • "job": {
    },
  • "jobAd": {
    },
  • "submittedDetails": {
    },
  • "screening": {
    },
  • "custom": [
    ],
  • "partnerActions": [
    ],
  • "owner": {
    },
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Update a job application

Update job application status and custom fields

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>
Request Body schema: application/json
statusId
integer <int32>

Job application status

rating
integer <int32> [ 0 .. 10 ]

Job application rating

Array of objects (SubmitCustomFieldValueModel)

Responses

Request samples

Content type
application/json
{
  • "statusId": 0,
  • "rating": 0,
  • "custom": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Set a job application status

Change the job application status and add an optional note

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>
Request Body schema: application/json
statusId
required
integer <int32>

Status Id

object (SubmitStatusNoteModel)

Optional note

Responses

Request samples

Content type
application/json
{
  • "statusId": 0,
  • "note": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Recently deleted job applications

Provides a list of job applications recently (last 14 days) deleted from JobAdder, allowing the management of referenced data for local privacy law compliance (e.g. GDPR).

Authorizations:
jobadder_identity (readread_jobapplication)

Responses

Response Schema: application/json
Array of objects (DeletedJobApplicationModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Videos

Get all videos

path Parameters
applicationId
required
integer <int64>

Responses

Response Schema: application/json
Array of objects (CandidateVideoModel)
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a recent video

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
applicationId
required
integer <int64>
videoType
required
string
Enum: "Other" "Profile" "CoverLetter"

Responses

Response Schema: application/json
type
required
string
Enum: "Other" "Profile" "CoverLetter"
url
string

Video URL

reference
string

Optional unique reference for this video type.

createdAt
string <date-time>

Date this video was added to the candidate

updatedAt
string <date-time>

Date this video was last updated (updates are possible when a video is added with a Reference)

Response samples

Content type
application/json
{
  • "type": "Other",
  • "url": "string",
  • "reference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Add a video

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>

Job Application Id

videoType
required
string
Enum: "Other" "Profile" "CoverLetter"
Request Body schema: application/json
url
required
string

Video URL

reference
string

Optional unique reference for this video type, if specified then an existing video with the same type and reference will be updated if found.

Responses

Response Schema: application/json
type
required
string
Enum: "Other" "Profile" "CoverLetter"
url
string

Video URL

reference
string

Optional unique reference for this video type.

createdAt
string <date-time>

Date this video was added to the candidate

updatedAt
string <date-time>

Date this video was last updated (updates are possible when a video is added with a Reference)

Request samples

Content type
application/json
{
  • "url": "string",
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "type": "Other",
  • "url": "string",
  • "reference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Attachments

Find attachments

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
applicationId
required
integer <int64>
query Parameters
type
Array of strings
Items Enum: "Other" "Resume" "CoverLetter" "FormattedResume" "Screening" "Check" "Reference" "License"

Attachment types to include

category
Array of strings

Search by attachment label

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CandidateAttachmentModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get an attachment

Get a job application attachment.
Setting the Accept header will attempt a file conversion.

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
applicationId
required
integer <int64>

Job Application Id

attach
required
integer <int64>

Attachment Id

Responses

Response Schema:
application/octet-stream
application/octet-stream
application/pdf
text/html
text/plain
string <binary>

Update attachment details

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>

Job Application Id

attach
required
integer <int64>

Attachment Id

Request Body schema: application/json
type
string
Enum: "Other" "Resume" "CoverLetter" "FormattedResume" "Screening" "Check" "Reference" "License"

Attachment type

category
string

Optional additional categorization for the attachment type

expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

Responses

Request samples

Content type
application/json
{
  • "type": "Other",
  • "category": "string",
  • "expiry": "2019-08-24"
}

Add a single attachment

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>

Job Application Id

attach
required
string
Enum: "Resume" "FormattedResume" "CoverLetter" "Screening" "Check" "Reference" "License" "Other"
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Response Schema: application/json
attachmentId
integer <int64>
type
string
Enum: "Other" "Resume" "CoverLetter" "FormattedResume" "Screening" "Check" "Reference" "License"
category
string
fileName
string
fileType
string
expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

object (UserNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (CandidateAttachmentLinks)

Response samples

Content type
application/json
{
  • "attachmentId": 0,
  • "type": "Other",
  • "category": "string",
  • "fileName": "string",
  • "fileType": "string",
  • "expiry": "2019-08-24",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Review

Mark a job application as viewed by the hiring manager

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>
Request Body schema: application/json
contactId
required
integer <int32>

Hiring manager contact viewing the applicant

Responses

Request samples

Content type
application/json
{
  • "contactId": 0
}

Submit a job application for review

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>
Request Body schema: application/json
submittedByUserId
integer <int32>

Optionally specify the user submitting the job application for review (if not the authenticated user)

Responses

Request samples

Content type
application/json
{
  • "submittedByUserId": 0
}

Accept a job application

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>
Request Body schema: application/json
contactId
required
integer <int32>

Hiring manager contact accepting the applicant

message
string

Optional feedback

Responses

Request samples

Content type
application/json
{
  • "contactId": 0,
  • "message": "string"
}

Reject a job application

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>
Request Body schema: application/json
contactId
required
integer <int32>

Hiring manager contact rejecting the applicant

reason
string

Optional feedback

Responses

Request samples

Content type
application/json
{
  • "contactId": 0,
  • "reason": "string"
}

Interviews

Get all Interviews

Authorizations:
jobadder_identity (readread_interview)
path Parameters
applicationId
required
integer <int64>

Job Application Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (InterviewSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Notes

Get job application notes

Authorizations:
jobadder_identity (readread_noteread_jobapplication_note)
path Parameters
applicationId
required
integer <int64>

Job Application Id

query Parameters
noteId
Array of strings <uuid>

Note Id

type
Array of strings

Note type

reference
Array of strings

Reference value used to identify a note or group of notes

createdAt
Array of strings

Search for notes created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for notes updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: type, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: text

Responses

Response Schema: application/json
Array of objects (NoteSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a note

Authorizations:
jobadder_identity (writewrite_notewrite_jobapplication_note)
path Parameters
applicationId
required
integer <int64>
Request Body schema: application/json
type
string <= 50 characters

Note type

text
required
string

Note content

reference
string <= 200 characters

Optional reference string used to identify a note or group of notes

object (SubmitUserModel)

The user creating the note if not the authenticated user.
Specify either userId or email.

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string",
  • "reference": "string",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Activities

Get job application activities

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
applicationId
required
integer <int64>

Job application Id

Responses

Response Schema: application/json
Array of objects (JobApplicationActivitySummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add a job application activity

Authorizations:
jobadder_identity (writewrite_jobapplication)
path Parameters
applicationId
required
integer <int64>

Job application Id

Request Body schema: application/json
activitySettingId
integer <int32>
statusId
integer <int32>
object (ActivityAnswerListModel)

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
applicationId
integer <int64>

Request samples

Content type
application/json
{
  • "activitySettingId": 0,
  • "statusId": 0,
  • "answers": {
    }
}

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "applicationId": 0
}

Get a job application activity

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
applicationId
required
integer <int64>

Job application Id

activityId
required
integer <int64>

Activity Id

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
applicationId
integer <int64>
object (ModelLinks)

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "applicationId": 0,
  • "links": {
    }
}

Find job application activities

Authorizations:
jobadder_identity (readread_jobapplication)
query Parameters
createdAt
Array of strings

Search for activities performed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

includeDetails
boolean
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationActivityModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all job application activity settings definitions

Authorizations:
jobadder_identity (readread_jobapplication)

Responses

Response Schema: application/json
Array of objects (JobApplicationActivitySettingSummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get job application activity settings with details

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
settingId
required
integer <int32>

Activity Setting Id

Responses

Response Schema: application/json
settingId
integer <int32>
activityType
string
name
string
Array of objects (StatusModel)
statusMandatory
boolean
Array of objects (ActivityQuestionModel)

Response samples

Content type
application/json
{
  • "settingId": 0,
  • "activityType": "string",
  • "name": "string",
  • "validStatuses": [
    ],
  • "statusMandatory": true,
  • "questions": [
    ]
}

Lists

Get all custom fields

Authorizations:
jobadder_identity (readread_jobapplication)

Responses

Response Schema: application/json
Array of objects (CustomFieldModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a custom field

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
fieldId
required
integer <int32>

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Modify custom field list values

Authorizations:
jobadder_identity (manage_jobapplication_custom)
path Parameters
fieldId
required
integer <int32>
Request Body schema: application/json
values
Array of strings

Available values for a list custom field

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Request samples

Content type
application/json
{
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Get all status definitions

Authorizations:
jobadder_identity (readread_jobapplication)
query Parameters
statusId
Array of integers <int32>
name
string
active
boolean
rejected
boolean
default
boolean

Responses

Response Schema: application/json
Array of objects (JobApplicationStatusModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a status definition

Authorizations:
jobadder_identity (readread_jobapplication)
path Parameters
statusId
required
integer <int32>

Responses

Response Schema: application/json
statusId
required
integer <int32>
name
required
string
active
boolean
rejected
boolean
default
boolean
defaultRejected
boolean
object (JobApplicationWorkflowModel)
object (JobApplicationStatusLinks)

Response samples

Content type
application/json
{
  • "statusId": 0,
  • "name": "string",
  • "active": true,
  • "rejected": true,
  • "default": true,
  • "defaultRejected": true,
  • "workflow": {
    },
  • "links": {
    }
}

Get the job application workflow

Authorizations:
jobadder_identity (readread_jobapplication)

Responses

Response Schema: application/json
Array of objects (JobApplicationStatusByWorkflowModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Placements

Find placements

Authorizations:
jobadder_identity (readread_placement)
query Parameters
placementId
Array of integers <int32>

Placement Id

type
Array of strings
Items Enum: "Permanent" "Contract" "Temporary" "Credit"

Placement Type

partnerAction.actionId
Array of strings <uuid>

Unique identifier for partner actions

partnerAction.reference
Array of strings

Partner supplied unique reference for the action

partnerAction.stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

partnerAction.submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

statusId
Array of integers <int32>

Placement status

candidate.candidateId
Array of integers <int32>

Candidate Id

candidate.name
string

Candidate name

candidateId
Array of integers <int32>

Alias for candidate.candidateId

company.companyId
Array of integers <int32>

Companies by Id

company.name
string

Company name

companyId
Array of integers <int32>

Alias for company.companyId

jobId
Array of integers <int32>

Job Id

applicationId
Array of integers <int64>

Job Application Id

startDate
Array of strings

Search for placements starting in the specified date range (ISO full-date). Prefix with < or > to search dates before or after (inclusive) the specified date. Specify multiple parameters to search for a range.

endDate
Array of strings

Search for placements ending in the specified date range (ISO full-date). Prefix with < or > to search dates before or after (inclusive) the specified date. Specify multiple parameters to search for a range.

folderId
Array of integers <int64>

Search in specific folders

userId
Array of integers <int32>

User Id - search for placements by owner or associated recruiter

ownerUserId
Array of integers <int32>

User Id - search for placements by owner

recruiterUserId
Array of integers <int32>

User Id - search placements by associated recruiters

createdBy
Array of integers <int32>

User Id - search for placements created by the specified user(s)

createdAt
Array of strings

Search for placements created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedBy
Array of integers <int32>

User Id - search for placements last updated by the specified user(s)

updatedAt
Array of strings

Search for placements updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

approved
boolean

Search for approved placements

approvedBy
Array of integers <int32>

User Id - search for placements approved by the specified user(s)

approvedAt
Array of strings

Search for placements approved at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

export
Array of strings
Items Enum: "Payroll" "Timesheets" "Onboarding"

Search for placements that have been flagged by the user for export to integration partners.

timesheet.period
Array of strings

Find placements with timesheets in the specified date range (ISO full-date). Prefix with < or > to search dates before or after (inclusive) the specified date. Specify multiple parameters to search for a range.

fields
Array of strings

Additional fields to include with the results. Fields available to include are: partnerActions

embed
Array of strings

Embed related resources.
Resources available to embed are: self, notes

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (PlacementSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a placement

Authorizations:
jobadder_identity (readread_placement)
path Parameters
placementId
required
integer <int32>

Placement Id

query Parameters
embed
Array of strings

Embed related resources.
Resources available to embed are: notes

Responses

Response Schema: application/json
placementId
required
integer <int32>
jobTitle
string
object (JobOrderTitleModel)
object (CandidateNameModel)
approved
boolean
approvedAt
string <date-time>
type
required
string
Enum: "Permanent" "Contract" "Temporary" "Credit"
object (StatusModel)
startDate
string <date>

Date employment begins

endDate
string <date>

Date a contract or temporary employment ends

summary
string
object (CompanyNameModel)
object (ContactNameModel)
object (PlacementSourceModel)
object (CompanyAddressModel)
paymentType
string
object (PlacementSalaryModel)
object (PlacementContractRateModel)
Array of objects (PlacementRateModel)
award
string
industryCode
string
chargeCurrency
string
feeSplit
string
Enum: "Fixed" "Percent"
object (PlacementBillingModel)
object (PlacementExportModel)
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (PlacementRecruiterModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (PlacementLinks)

Response samples

Content type
application/json
{
  • "placementId": 0,
  • "jobTitle": "string",
  • "job": {
    },
  • "candidate": {
    },
  • "approved": true,
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "type": "Permanent",
  • "status": {
    },
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "summary": "string",
  • "company": {
    },
  • "contact": {
    },
  • "source": {
    },
  • "workplaceAddress": {
    },
  • "paymentType": "string",
  • "salary": {
    },
  • "contractRate": {
    },
  • "rates": [
    ],
  • "award": "string",
  • "industryCode": "string",
  • "chargeCurrency": "string",
  • "feeSplit": "Fixed",
  • "billing": {
    },
  • "export": {
    },
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "partnerActions": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Update a placement

Authorizations:
jobadder_identity (writewrite_placement)
path Parameters
placementId
required
integer <int32>
Request Body schema: application/json
jobTitle
required
string [ 0 .. 100 ] characters
contactId
integer <int32>
summary
string
statusId
integer <int32>

Placement status

paymentType
string [ 0 .. 50 ] characters
startDate
string <date>

Date employment begins

endDate
string <date>

Date a contract or temporary employment ends

object (SubmitPlacementSalaryModel)
object (SubmitPlacementContractRateModel)
award
string [ 0 .. 100 ] characters
industryCode
string [ 0 .. 100 ] characters
object (SubmitPlacementBillingModel)
feeSplit
string
Enum: "Fixed" "Percent"
Array of objects (SubmitPlacementRecruiterModel)
Array of objects (SubmitCustomFieldValueModel)

Responses

Request samples

Content type
application/json
{
  • "jobTitle": "string",
  • "contactId": 0,
  • "summary": "string",
  • "statusId": 0,
  • "paymentType": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "salary": {
    },
  • "contractRate": {
    },
  • "award": "string",
  • "industryCode": "string",
  • "billing": {
    },
  • "feeSplit": "Fixed",
  • "recruiters": [
    ],
  • "custom": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Set a placement status

Change the placement status and add an optional note

Authorizations:
jobadder_identity (writewrite_placement)
path Parameters
placementId
required
integer <int32>
Request Body schema: application/json
statusId
required
integer <int32>

Status Id

object (SubmitStatusNoteModel)

Optional note

Responses

Request samples

Content type
application/json
{
  • "statusId": 0,
  • "note": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Recently deleted placements

Provides a list of placements recently (last 14 days) deleted from JobAdder.

Authorizations:
jobadder_identity (readread_placement)

Responses

Response Schema: application/json
Array of objects (DeletedPlacementModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all custom fields

Authorizations:
jobadder_identity (readread_placement)

Responses

Response Schema: application/json
Array of objects (CustomFieldModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a custom field

Authorizations:
jobadder_identity (readread_placement)
path Parameters
fieldId
required
integer <int32>

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Modify custom field list values

Authorizations:
jobadder_identity (manage_placement_custom)
path Parameters
fieldId
required
integer <int32>
Request Body schema: application/json
values
Array of strings

Available values for a list custom field

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Request samples

Content type
application/json
{
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Attachments

Find attachments

Authorizations:
jobadder_identity (readread_placement)
path Parameters
placementId
required
integer <int32>
query Parameters
type
Array of strings
Items Enum: "Other" "Resume" "FormattedResume" "CoverLetter" "Screening" "Check" "Reference" "License" "Terms" "CompanyTerms" "StandardTerms"

Attachment types to include

latest
boolean

Find the latest version of each attachment type

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (PlacementAttachmentModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get an attachment

Get a placement attachment.
Setting the Accept header will attempt a file conversion.

Authorizations:
jobadder_identity (readread_placement)
path Parameters
placementId
required
integer <int32>

Placement Id

attach
required
integer <int64>

Attachment Id

Responses

Response Schema: application/octet-stream
string <binary>

Update attachment details

Authorizations:
jobadder_identity (writewrite_placement)
path Parameters
placementId
required
integer <int32>

Placement Id

attach
required
integer <int64>

Attachment Id

Request Body schema: application/json
type
string
Enum: "Other" "Resume" "FormattedResume" "CoverLetter" "Screening" "Check" "Reference" "License" "Terms" "CompanyTerms" "StandardTerms"

Attachment type

category
string

Optional additional categorization for the attachment type

expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

Responses

Request samples

Content type
application/json
{
  • "type": "Other",
  • "category": "string",
  • "expiry": "2019-08-24"
}

Add a single attachment

Authorizations:
jobadder_identity (writewrite_placement)
path Parameters
placementId
required
integer <int32>

Placement Id

attach
required
string
Enum: "Other" "Resume" "FormattedResume" "CoverLetter" "Screening" "Check" "Reference" "License" "Terms" "CompanyTerms" "StandardTerms"
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Response Schema: application/json
attachmentId
integer <int64>
type
string
Enum: "Other" "Resume" "FormattedResume" "CoverLetter" "Screening" "Check" "Reference" "License" "Terms" "CompanyTerms" "StandardTerms"
category
string
fileName
string
fileType
string
expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

object (UserNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (PlacementAttachmentLinks)

Response samples

Content type
application/json
{
  • "attachmentId": 0,
  • "type": "Other",
  • "category": "string",
  • "fileName": "string",
  • "fileType": "string",
  • "expiry": "2019-08-24",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Get all attachment categories

Authorizations:
jobadder_identity (readread_placement)
query Parameters
type
Array of strings
Items Enum: "Other" "Resume" "FormattedResume" "CoverLetter" "Screening" "Check" "Reference" "License" "Terms" "CompanyTerms" "StandardTerms"

Optionally filter to specific attachment types

Responses

Response Schema: application/json
Array of objects (PlacementAttachmentCategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Timesheets

Get timesheets

Authorizations:
jobadder_identity (readread_placement)
path Parameters
placementId
required
integer <int32>

Placement Id

query Parameters
period
Array of strings

Get timesheets for a specific date range (ISO full-date). Prefix with < or > to search dates before or after (inclusive) the specified date. Specify multiple parameters to search for a range.

Responses

Response Schema: application/json
Array of objects (PlacementTimesheetModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Notes

Get placement notes

Authorizations:
jobadder_identity (readread_noteread_placement_note)
path Parameters
placementId
required
integer <int32>

Placement Id

query Parameters
noteId
Array of strings <uuid>

Note Id

type
Array of strings

Note type

reference
Array of strings

Reference value used to identify a note or group of notes

createdAt
Array of strings

Search for notes created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for notes updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: type, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: text

Responses

Response Schema: application/json
Array of objects (NoteSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a note

Authorizations:
jobadder_identity (writewrite_notewrite_placement_note)
path Parameters
placementId
required
integer <int32>
Request Body schema: application/json
type
string <= 50 characters

Note type

text
required
string

Note content

reference
string <= 200 characters

Optional reference string used to identify a note or group of notes

object (SubmitUserModel)

The user creating the note if not the authenticated user.
Specify either userId or email.

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string",
  • "reference": "string",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get all note types

Authorizations:
jobadder_identity (readread_noteread_placement_note)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NoteTypeModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Activities

Get placement activities

Authorizations:
jobadder_identity (readread_placement)
path Parameters
placementId
required
integer <int32>

Placement Id

Responses

Response Schema: application/json
Array of objects (PlacementActivitySummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add a placement activity

Authorizations:
jobadder_identity (writewrite_placement)
path Parameters
placementId
required
integer <int32>

Placement Id

Request Body schema: application/json
activitySettingId
integer <int32>
statusId
integer <int32>
object (ActivityAnswerListModel)

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
placementId
integer <int32>

Request samples

Content type
application/json
{
  • "activitySettingId": 0,
  • "statusId": 0,
  • "answers": {
    }
}

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "placementId": 0
}

Get a placement activity

Authorizations:
jobadder_identity (readread_placement)
path Parameters
placementId
required
integer <int32>

Placement Id

activityId
required
integer <int64>

Activity Id

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
placementId
integer <int32>
object (ModelLinks)

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "placementId": 0,
  • "links": {
    }
}

Find placement activities

Authorizations:
jobadder_identity (readread_placement)
query Parameters
createdAt
Array of strings

Search for activities performed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

includeDetails
boolean
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (PlacementActivityModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all placement activity settings definitions

Authorizations:
jobadder_identity (readread_placement)

Responses

Response Schema: application/json
Array of objects (PlacementActivitySettingSummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get placement activity settings with details

Authorizations:
jobadder_identity (readread_placement)
path Parameters
settingId
required
integer <int32>

Activity Setting Id

Responses

Response Schema: application/json
settingId
integer <int32>
activityType
string
name
string
Array of objects (StatusModel)
statusMandatory
boolean
Array of objects (ActivityQuestionModel)

Response samples

Content type
application/json
{
  • "settingId": 0,
  • "activityType": "string",
  • "name": "string",
  • "validStatuses": [
    ],
  • "statusMandatory": true,
  • "questions": [
    ]
}

Lists

Get all awards

Authorizations:
jobadder_identity (readread_placement)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all billing terms

Authorizations:
jobadder_identity (readread_placement)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all industry codes

Authorizations:
jobadder_identity (readread_placement)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all payment types

Authorizations:
jobadder_identity (readread_placement)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all status definitions

Authorizations:
jobadder_identity (readread_placement)
query Parameters
statusId
Array of integers <int32>
name
string
active
boolean
default
boolean

Responses

Response Schema: application/json
Array of objects (StatusModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a status definition

Authorizations:
jobadder_identity (readread_placement)
path Parameters
statusId
required
integer <int32>

Responses

Response Schema: application/json
statusId
required
integer <int32>
name
required
string
active
boolean
default
boolean
object (ModelLinks)

Response samples

Content type
application/json
{
  • "statusId": 0,
  • "name": "string",
  • "active": true,
  • "default": true,
  • "links": {
    }
}

Companies

Find companies

Authorizations:
jobadder_identity (readread_company)
query Parameters
name
string

Company name

companyId
Array of integers <int32>

Companies by Id

parentId
Array of integers <int32>

Find subsidiaries of specified parent companies

subsidiaryId
Array of integers <int32>

Find parents of specified subsidiaries

statusId
Array of integers <int32>

Company status

partnerAction.actionId
Array of strings <uuid>

Unique identifier for partner actions

partnerAction.reference
Array of strings

Partner supplied unique reference for the action

partnerAction.stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

partnerAction.submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

folderId
Array of integers <int64>

Search in specific folders

createdBy
Array of integers <int32>

User Id - search for companies created by the specified user(s)

createdAt
Array of strings

Search for companies created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedBy
Array of integers <int32>

User Id - search for companies last updated by the specified user(s)

updatedAt
Array of strings

Search for companies updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

fields
Array of strings

Additional fields to include with the results. Fields available to include are: partnerActions

embed
Array of strings

Embed related resources.
Resources available to embed are: self, addresses, contacts, subsidiaries, skills, notes, jobs, placements, workflows

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CompanySummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a new company

Authorizations:
jobadder_identity (writewrite_company)
header Parameters
X-Allow-Duplicates
string

Duplicate override code from the header of an earlier 409 response

Request Body schema: application/json
name
required
string [ 0 .. 100 ] characters
parentCompanyId
integer <int32>
summary
string
object
statusId
integer <int32>

Company status

Array of objects (SubmitCustomFieldValueModel)

Custom field values. Only the specified fields will be updated, each fieldId can specified once.

ownerUserId
integer <int32>
recruiterUserId
Array of integers <int32>

Responses

Response Schema: application/json
companyId
required
integer <int32>

Unique identifier for the company

name
string

Company name

object (StatusModel)
object (ContactNameModel)
object (CompanyAddressModel)
object

Company social profiles

summary
string
object (CompanyNameModel)
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (UserNameModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (CompanyLinks)

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "companyId": 0,
  • "name": "string",
  • "status": {
    },
  • "mainContact": {
    },
  • "primaryAddress": {
    },
  • "social": {
    },
  • "summary": "string",
  • "parent": {
    },
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "partnerActions": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Get a company

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Company Id

query Parameters
embed
Array of strings

Embed related resources.
Resources available to embed are: addresses, contacts, subsidiaries, skills, notes, jobs, placements, workflows

Responses

Response Schema: application/json
companyId
required
integer <int32>

Unique identifier for the company

name
string

Company name

object (StatusModel)
object (ContactNameModel)
object (CompanyAddressModel)
object

Company social profiles

summary
string
object (CompanyNameModel)
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (UserNameModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (CompanyLinks)

Response samples

Content type
application/json
{
  • "companyId": 0,
  • "name": "string",
  • "status": {
    },
  • "mainContact": {
    },
  • "primaryAddress": {
    },
  • "social": {
    },
  • "summary": "string",
  • "parent": {
    },
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "partnerActions": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Update an existing company

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>
header Parameters
X-Allow-Duplicates
string

Duplicate override code from the header of an earlier 409 response

Request Body schema: application/json
name
required
string [ 0 .. 100 ] characters
mainContactId
integer <int32>
primaryAddressId
string <uuid>
parentCompanyId
integer <int32>
summary
string
object
statusId
integer <int32>

Company status

Array of objects (SubmitCustomFieldValueModel)

Custom field values. Only the specified fields will be updated, each fieldId can specified once.

ownerUserId
integer <int32>
recruiterUserId
Array of integers <int32>

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Get all subsidiaries for a company

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (CompanySummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Set a company status

Change the company status and add an optional note

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>
Request Body schema: application/json
statusId
required
integer <int32>

Status Id

object (SubmitStatusNoteModel)

Optional note

Responses

Request samples

Content type
application/json
{
  • "statusId": 0,
  • "note": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Recently deleted companies

Provides a list of companies recently (last 14 days) deleted from JobAdder.

Authorizations:
jobadder_identity (readread_company)

Responses

Response Schema: application/json
Array of objects (DeletedCompanyModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Addresses

Get all addresses

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (CompanyAddressModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Add an address

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>
Request Body schema: application/json
street
Array of strings
city
string
state
string
postalCode
string
countryCode
string
phone
string
fax
string
url
string
name
required
string

Responses

Response Schema: application/json
addressId
required
string <uuid>
name
string
street
Array of strings
city
string
state
string
postalCode
string
country
string
countryCode
string
phone
string
fax
string
url
string
object (ModelLinks)

Request samples

Content type
application/json
{
  • "street": [
    ],
  • "city": "string",
  • "state": "string",
  • "postalCode": "string",
  • "countryCode": "string",
  • "phone": "string",
  • "fax": "string",
  • "url": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "addressId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "street": [
    ],
  • "city": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "countryCode": "string",
  • "phone": "string",
  • "fax": "string",
  • "url": "string",
  • "links": {
    }
}

Get an address

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Company Id

addressId
required
string <uuid>

Address Id

Responses

Response Schema: application/json
addressId
required
string <uuid>
name
string
street
Array of strings
city
string
state
string
postalCode
string
country
string
countryCode
string
phone
string
fax
string
url
string
object (ModelLinks)

Response samples

Content type
application/json
{
  • "addressId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "street": [
    ],
  • "city": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "countryCode": "string",
  • "phone": "string",
  • "fax": "string",
  • "url": "string",
  • "links": {
    }
}

Update an address

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>
addressId
required
string <uuid>
Request Body schema: application/json
name
string
street
Array of strings
city
string
state
string
postalCode
string
countryCode
string
phone
string
fax
string
url
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "street": [
    ],
  • "city": "string",
  • "state": "string",
  • "postalCode": "string",
  • "countryCode": "string",
  • "phone": "string",
  • "fax": "string",
  • "url": "string"
}

Remove an address

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>
addressId
required
string <uuid>

Responses

Skills

Get company skills

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Responses

Response Schema: application/json
Array of objects (CategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Contacts

Get company contacts

Authorizations:
jobadder_identity (readread_contact)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (ContactSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Attachments

Find attachments

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>
query Parameters
type
Array of strings
Items Enum: "Other" "Terms"

Attachment types to include

latest
boolean

Find the latest version of each attachment type

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CompanyAttachmentModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get an attachment

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>
attach
required
integer <int64>

Responses

Response Schema: application/octet-stream
string <binary>

Update attachment details

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>

Company Id

attach
required
integer <int64>

Attachment Id

Request Body schema: application/json
type
string
Enum: "Other" "Terms"

Attachment type

category
string

Optional additional categorization for the attachment type

expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

Responses

Request samples

Content type
application/json
{
  • "type": "Other",
  • "category": "string",
  • "expiry": "2019-08-24"
}

Add a single attachment

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>

Company Id

attach
required
string
Enum: "Other" "Terms"
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Response Schema: application/json
attachmentId
integer <int64>
type
string
Enum: "Other" "Terms"
category
string
fileName
string
fileType
string
expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

object (UserNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (CompanyAttachmentLinks)

Response samples

Content type
application/json
{
  • "attachmentId": 0,
  • "type": "Other",
  • "category": "string",
  • "fileName": "string",
  • "fileType": "string",
  • "expiry": "2019-08-24",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Get all attachment categories

Authorizations:
jobadder_identity (readread_company)
query Parameters
type
Array of strings
Items Enum: "Other" "Terms"

Optionally filter to specific attachment types

Responses

Response Schema: application/json
Array of objects (CompanyAttachmentCategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Jobs

Get all jobs for a company

Authorizations:
jobadder_identity (readread_job)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (JobOrderSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all active/open jobs for a company

Authorizations:
jobadder_identity (readread_job)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (JobOrderSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Requisitions

Get all requisitions for a company

Authorizations:
jobadder_identity (readread_requisition)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (RequisitionSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Floats

Get all floats for a company

Authorizations:
jobadder_identity (readread_float)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (FloatSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Submissions

Get all candidate submissions for a company

Authorizations:
jobadder_identity (readread_submission)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (SubmissionSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Placements

Get all approved and unapproved placements for a company

Authorizations:
jobadder_identity (readread_placement)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (PlacementSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all approved placements for a company

Authorizations:
jobadder_identity (readread_placement)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (PlacementSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Workflows

Get all company workflows

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Company Id

workflowType
required
string
Value: "Requisition"

Valid values: "Requisition"

query Parameters
workflowId
Array of integers <int32>
include
Array of strings
Items Value: "Archived"
embed
Array of strings

Embed related resources within the results.

Responses

Response Schema: application/json
Array of objects (CompanyWorkflowNameModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Add a company workflow

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>

Company Id

workflowType
required
string
Value: "Requisition"

Valid values: "Requisition"

Request Body schema: application/json
Array of objects (SubmitCompanyWorkflowApproverModel)

Approvers for this workflow. Only the specified workflow stages will be updated, each stageIndex can be specified once.

name
required
string

Responses

Response Schema: application/json
workflowId
required
integer <int32>
name
required
string
archived
boolean
Array of objects (CompanyWorkflowApproverModel)
object (ModelLinks)

Request samples

Content type
application/json
{
  • "approvers": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "workflowId": 0,
  • "name": "string",
  • "archived": true,
  • "approvers": [
    ],
  • "links": {
    }
}

Get a company workflow and approvers

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Company Id

workflowType
required
string
Value: "Requisition"

Valid values: "Requisition"

workflowId
required
integer <int32>

Workflow Id

Responses

Response Schema: application/json
workflowId
required
integer <int32>
name
required
string
archived
boolean
Array of objects (CompanyWorkflowApproverModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "workflowId": 0,
  • "name": "string",
  • "archived": true,
  • "approvers": [
    ],
  • "links": {
    }
}

Update a company workflow

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>

Company Id

workflowType
required
string
Value: "Requisition"

Valid values: "Requisition"

workflowId
required
integer <int32>

Workflow Id

Request Body schema: application/json
name
string
Array of objects (SubmitCompanyWorkflowApproverModel)

Approvers for this workflow. Only the specified workflow stages will be updated, each stageIndex can be specified once.

Responses

Response Schema: application/json
workflowId
required
integer <int32>
name
required
string
archived
boolean
Array of objects (CompanyWorkflowApproverModel)
object (ModelLinks)

Request samples

Content type
application/json
{
  • "name": "string",
  • "approvers": [
    ]
}

Response samples

Content type
application/json
{
  • "workflowId": 0,
  • "name": "string",
  • "archived": true,
  • "approvers": [
    ],
  • "links": {
    }
}

Notes

Get company notes

Authorizations:
jobadder_identity (readread_noteread_company_note)
path Parameters
companyId
required
integer <int32>

Company Id

query Parameters
noteId
Array of strings <uuid>

Note Id

type
Array of strings

Note type

reference
Array of strings

Reference value used to identify a note or group of notes

createdAt
Array of strings

Search for notes created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for notes updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: type, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: text

Responses

Response Schema: application/json
Array of objects (NoteSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a company note

Authorizations:
jobadder_identity (writewrite_notewrite_company_note)
path Parameters
companyId
required
integer <int32>
Request Body schema: application/json
type
string <= 50 characters

Note type

text
required
string

Note content

contactId
Array of integers <int32>

Optional list of related contacts to link to the note

reference
string <= 200 characters

Optional reference string used to identify a note or group of notes

object (SubmitUserModel)

The user creating the note if not the authenticated user.
Specify either userId or email.

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string",
  • "contactId": [
    ],
  • "reference": "string",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get a list of company note types

Authorizations:
jobadder_identity (readread_noteread_candidate_note)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NoteTypeModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Activities

Get company activities

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Company Id

Responses

Response Schema: application/json
Array of objects (CompanyActivitySummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add a company activity

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
companyId
required
integer <int32>

Company Id

Request Body schema: application/json
activitySettingId
integer <int32>
statusId
integer <int32>
object (ActivityAnswerListModel)

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
companyId
integer <int32>

Request samples

Content type
application/json
{
  • "activitySettingId": 0,
  • "statusId": 0,
  • "answers": {
    }
}

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "companyId": 0
}

Get a company activity

Authorizations:
jobadder_identity (readread_company)
path Parameters
companyId
required
integer <int32>

Company Id

activityId
required
integer <int64>

Activity Id

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
companyId
integer <int32>
object (ModelLinks)

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "companyId": 0,
  • "links": {
    }
}

Find company activities

Authorizations:
jobadder_identity (readread_company)
query Parameters
createdAt
Array of strings

Search for activities performed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

includeDetails
boolean
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CompanyActivityModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all company activity settings definitions

Authorizations:
jobadder_identity (readread_company)

Responses

Response Schema: application/json
Array of objects (CompanyActivitySettingSummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get Company activity settings with details

Authorizations:
jobadder_identity (readread_company)
path Parameters
settingId
required
integer <int32>

Activity Setting Id

Responses

Response Schema: application/json
settingId
integer <int32>
activityType
string
name
string
Array of objects (StatusModel)
statusMandatory
boolean
Array of objects (ActivityQuestionModel)

Response samples

Content type
application/json
{
  • "settingId": 0,
  • "activityType": "string",
  • "name": "string",
  • "validStatuses": [
    ],
  • "statusMandatory": true,
  • "questions": [
    ]
}

Lists

Get the list of company custom fields

Authorizations:
jobadder_identity (readread_company)

Responses

Response Schema: application/json
Array of objects (CustomFieldModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a company custom field

Authorizations:
jobadder_identity (readread_company)
path Parameters
fieldId
required
integer <int32>

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Modify custom field list values

Authorizations:
jobadder_identity (manage_company_custom)
path Parameters
fieldId
required
integer <int32>
Request Body schema: application/json
values
Array of strings

Available values for a list custom field

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Request samples

Content type
application/json
{
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Get a list of company status definitions

Authorizations:
jobadder_identity (readread_company)
query Parameters
statusId
Array of integers <int32>
name
string
active
boolean
default
boolean

Responses

Response Schema: application/json
Array of objects (StatusModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a company status

Authorizations:
jobadder_identity (readread_company)
path Parameters
statusId
required
integer <int32>

Responses

Response Schema: application/json
statusId
required
integer <int32>
name
required
string
active
boolean
default
boolean
object (ModelLinks)

Response samples

Content type
application/json
{
  • "statusId": 0,
  • "name": "string",
  • "active": true,
  • "default": true,
  • "links": {
    }
}

Contacts

Find contacts

Authorizations:
jobadder_identity (readread_contact)
query Parameters
contactId
Array of integers <int32>

Contact Id

name
string

Contact name

email
string

Contact email

phone
string

Contact phone or mobile number

companyId
Array of integers <int32>

Company Id

hiringManager
boolean
statusId
Array of integers <int32>
partnerAction.actionId
Array of strings <uuid>

Unique identifier for partner actions

partnerAction.reference
Array of strings

Partner supplied unique reference for the action

partnerAction.stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

partnerAction.submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

folderId
Array of integers <int64>

Search in specific folders

createdBy
Array of integers <int32>

User Id - search for contacts created by the specified user(s)

createdAt
Array of strings

Search for contacts created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedBy
Array of integers <int32>

User Id - search for contacts last updated by the specified user(s)

updatedAt
Array of strings

Search for contacts updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

fields
Array of strings

Additional fields to include with the results. Fields available to include are: partnerActions

embed
Array of strings

Embed related resources.
Resources available to embed are: self, skills, notes, jobs

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (ContactSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a new contact

Authorizations:
jobadder_identity (writewrite_contact)
header Parameters
X-Allow-Duplicates
string

Duplicate override code from the header of an earlier 409 response

Request Body schema: application/json
firstName
string <= 50 characters
lastName
string <= 50 characters
email
string <= 100 characters
phone
string <= 50 characters
mobile
string <= 50 characters
salutation
string <= 20 characters

Salutation/honorific/title

summary
string
object
position
string
companyId
integer <int32>
reportsToContactId
integer <int32>
officeAddressId
string <uuid>
statusId
integer <int32>

Contact status

Array of objects (SubmitCustomFieldValueModel)
ownerUserId
integer <int32>
recruiterUserId
Array of integers <int32>

Responses

Response Schema: application/json
contactId
required
integer <int32>

Unique identifier for the contact

firstName
string

First name

lastName
string

Last name

position
string

Position or job title

salutation
string

Salutation/honorific/title

email
string

Primary email address

phone
string

Phone number

mobile
string

Mobile/cell number

inactive
boolean

Contact is no longer with the company

object (StatusModel)
object (CompanyNameModel)
object (CompanyAddressModel)
previousContactId
integer <int32>

contactId from the previous company when a contact moves between companies

originalContactId
integer <int32>

contactId from the original/first company when a contact moves between companies

otherEmail
Array of strings

Other email addresses used by the contact

object

Contact social profiles

summary
string
object (ContactNameModel)
hiringManager
boolean
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (UserNameModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ContactLinks)

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "contactId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "salutation": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "inactive": true,
  • "status": {
    },
  • "company": {
    },
  • "officeAddress": {
    },
  • "previousContactId": 0,
  • "originalContactId": 0,
  • "otherEmail": [
    ],
  • "social": {
    },
  • "summary": "string",
  • "reportsTo": {
    },
  • "hiringManager": true,
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "partnerActions": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Get a contact

Authorizations:
jobadder_identity (readread_contact)
path Parameters
contactId
required
integer <int32>

Contact Id

query Parameters
embed
Array of strings

Embed related resources.
Resources available to embed are: skills, notes, jobs

Responses

Response Schema: application/json
contactId
required
integer <int32>

Unique identifier for the contact

firstName
string

First name

lastName
string

Last name

position
string

Position or job title

salutation
string

Salutation/honorific/title

email
string

Primary email address

phone
string

Phone number

mobile
string

Mobile/cell number

inactive
boolean

Contact is no longer with the company

object (StatusModel)
object (CompanyNameModel)
object (CompanyAddressModel)
previousContactId
integer <int32>

contactId from the previous company when a contact moves between companies

originalContactId
integer <int32>

contactId from the original/first company when a contact moves between companies

otherEmail
Array of strings

Other email addresses used by the contact

object

Contact social profiles

summary
string
object (ContactNameModel)
hiringManager
boolean
Array of objects (CustomFieldValueModel)
object (UserNameModel)
Array of objects (UserNameModel)
Array of objects (PartnerActionStageModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ContactLinks)

Response samples

Content type
application/json
{
  • "contactId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "salutation": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "inactive": true,
  • "status": {
    },
  • "company": {
    },
  • "officeAddress": {
    },
  • "previousContactId": 0,
  • "originalContactId": 0,
  • "otherEmail": [
    ],
  • "social": {
    },
  • "summary": "string",
  • "reportsTo": {
    },
  • "hiringManager": true,
  • "custom": [
    ],
  • "owner": {
    },
  • "recruiters": [
    ],
  • "partnerActions": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Update an existing contact

Authorizations:
jobadder_identity (writewrite_contact)
path Parameters
contactId
required
integer <int32>
header Parameters
X-Allow-Duplicates
string

Duplicate override code from the header of an earlier 409 response

Request Body schema: application/json
firstName
string <= 50 characters
lastName
string <= 50 characters
email
string <= 100 characters
phone
string <= 50 characters
mobile
string <= 50 characters
salutation
string <= 20 characters

Salutation/honorific/title

summary
string
object
position
string
companyId
integer <int32>
reportsToContactId
integer <int32>
officeAddressId
string <uuid>
statusId
integer <int32>

Contact status

Array of objects (SubmitCustomFieldValueModel)
ownerUserId
integer <int32>
recruiterUserId
Array of integers <int32>

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Get a contact photo

Authorizations:
jobadder_identity (readread_contact)
path Parameters
contactId
required
integer <int32>

Contact Id

query Parameters
w
integer <int32>

Reduce the size of the photo to fit the width specified by w

h
integer <int32>

Reduce the size of the photo to fit the height specified by g

Responses

Response Headers
ETag
string

Photo version, can be used for cache validation

Response Schema:
image/jpeg
image/jpeg
image/gif
image/png
string <binary>

Update a contact photo

Authorizations:
jobadder_identity (writewrite_contact)
path Parameters
contactId
required
integer <int32>
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Remove photo

Authorizations:
jobadder_identity (writewrite_contact)
path Parameters
contactId
required
integer <int32>

Responses

Get a contact photo headers

Authorizations:
jobadder_identity (readread_contact)
path Parameters
contactId
required
integer <int32>

Contact Id

query Parameters
w
integer <int32>

Reduce the size of the photo to fit the width specified by w

h
integer <int32>

Reduce the size of the photo to fit the height specified by g

Responses

Response Headers
ETag
string

Photo version, can be used for cache validation

Set a contact status

Change the contact status and add an optional note

Authorizations:
jobadder_identity (writewrite_contact)
path Parameters
contactId
required
integer <int32>
Request Body schema: application/json
statusId
required
integer <int32>

Status Id

object (SubmitStatusNoteModel)

Optional note

Responses

Request samples

Content type
application/json
{
  • "statusId": 0,
  • "note": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Recently deleted contacts

Provides a list of contacts recently (last 14 days) deleted from JobAdder, allowing the management of referenced data for local privacy law compliance (e.g. GDPR).

Authorizations:
jobadder_identity (readread_contact)

Responses

Response Schema: application/json
Array of objects (DeletedContactModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Jobs

Get all jobs for a contact

Authorizations:
jobadder_identity (readread_job)
path Parameters
contactId
required
integer <int32>

Contact Id

Responses

Response Schema: application/json
Array of objects (JobOrderSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all active/open jobs for a contact

Authorizations:
jobadder_identity (readread_job)
path Parameters
contactId
required
integer <int32>

Contact Id

Responses

Response Schema: application/json
Array of objects (JobOrderSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Interviews

Get all Interviews

Authorizations:
jobadder_identity (readread_interview)
path Parameters
contactId
required
integer <int32>

Contact Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (InterviewSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Skills

Get contact skills

Authorizations:
jobadder_identity (readread_contact)
path Parameters
contactId
required
integer <int32>

Responses

Response Schema: application/json
Array of objects (CategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Attachments

Find attachments

Authorizations:
jobadder_identity (readread_contact)
path Parameters
contactId
required
integer <int32>
query Parameters
type
Array of strings
Items Enum: "Other" "Terms"

Attachment types to include

latest
boolean

Find the latest version of each attachment type

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (ContactAttachmentModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get an attachment

Authorizations:
jobadder_identity (readread_contact)
path Parameters
contactId
required
integer <int32>
attach
required
integer <int64>

Responses

Response Schema: application/octet-stream
string <binary>

Update attachment details

Authorizations:
jobadder_identity (writewrite_contact)
path Parameters
contactId
required
integer <int32>

Contact Id

attach
required
integer <int64>

Attachment Id

Request Body schema: application/json
type
string
Enum: "Other" "Terms"

Attachment type

category
string

Optional additional categorization for the attachment type

expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

Responses

Request samples

Content type
application/json
{
  • "type": "Other",
  • "category": "string",
  • "expiry": "2019-08-24"
}

Add a single attachment

Authorizations:
jobadder_identity (writewrite_contact)
path Parameters
contactId
required
integer <int32>

Contact Id

attach
required
string
Enum: "Other" "Terms"
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Response Schema: application/json
attachmentId
integer <int64>
type
string
Enum: "Other" "Terms"
category
string
fileName
string
fileType
string
expiry
string <date>

Optional expiry date as listed on the document, e.g. a license expiry date

object (UserNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (ContactAttachmentLinks)

Response samples

Content type
application/json
{
  • "attachmentId": 0,
  • "type": "Other",
  • "category": "string",
  • "fileName": "string",
  • "fileType": "string",
  • "expiry": "2019-08-24",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Get all attachment categories

Authorizations:
jobadder_identity (readread_contact)
query Parameters
type
Array of strings
Items Enum: "Other" "Terms"

Optionally filter to specific attachment types

Responses

Response Schema: application/json
Array of objects (ContactAttachmentCategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Notes

Get contact notes

Authorizations:
jobadder_identity (readread_noteread_contact_note)
path Parameters
contactId
required
integer <int32>

Contact Id

query Parameters
noteId
Array of strings <uuid>

Note Id

type
Array of strings

Note type

reference
Array of strings

Reference value used to identify a note or group of notes

createdAt
Array of strings

Search for notes created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for notes updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: type, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: text

Responses

Response Schema: application/json
Array of objects (NoteSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a contact note

Authorizations:
jobadder_identity (writewrite_notewrite_contact_note)
path Parameters
contactId
required
integer <int32>
Request Body schema: application/json
type
string <= 50 characters

Note type

text
required
string

Note content

reference
string <= 200 characters

Optional reference string used to identify a note or group of notes

object (SubmitUserModel)

The user creating the note if not the authenticated user.
Specify either userId or email.

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string",
  • "reference": "string",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get a list of contact note types

Authorizations:
jobadder_identity (readread_noteread_contact_note)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NoteTypeModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Activities

Get contact activities

Authorizations:
jobadder_identity (readread_contact)
path Parameters
contactId
required
integer <int32>

Contact Id

Responses

Response Schema: application/json
Array of objects (ContactActivitySummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add a contact activity

Authorizations:
jobadder_identity (writewrite_company)
path Parameters
contactId
required
integer <int32>

Contact Id

Request Body schema: application/json
activitySettingId
integer <int32>
statusId
integer <int32>
object (ActivityAnswerListModel)

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
contactId
integer <int32>

Request samples

Content type
application/json
{
  • "activitySettingId": 0,
  • "statusId": 0,
  • "answers": {
    }
}

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "contactId": 0
}

Get a contact activity

Authorizations:
jobadder_identity (readread_contact)
path Parameters
contactId
required
integer <int32>

Contact Id

activityId
required
integer <int64>

Activity Id

Responses

Response Schema: application/json
activityId
integer <int64>
activityName
string
activityType
string
status
string
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (ActivityDetailListModel)
contactId
integer <int32>
object (ModelLinks)

Response samples

Content type
application/json
{
  • "activityId": 0,
  • "activityName": "string",
  • "activityType": "string",
  • "status": "string",
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "contactId": 0,
  • "links": {
    }
}

Find contact activities

Authorizations:
jobadder_identity (readread_contact)
query Parameters
createdAt
Array of strings

Search for activities performed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

includeDetails
boolean
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (ContactActivityModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get all contact activity settings definitions

Authorizations:
jobadder_identity (readread_contact)

Responses

Response Schema: application/json
Array of objects (ContactActivitySettingSummaryModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get contact activity settings with details

Authorizations:
jobadder_identity (readread_contact)
path Parameters
settingId
required
integer <int32>

Activity Setting Id

Responses

Response Schema: application/json
settingId
integer <int32>
activityType
string
name
string
Array of objects (StatusModel)
statusMandatory
boolean
Array of objects (ActivityQuestionModel)

Response samples

Content type
application/json
{
  • "settingId": 0,
  • "activityType": "string",
  • "name": "string",
  • "validStatuses": [
    ],
  • "statusMandatory": true,
  • "questions": [
    ]
}

Lists

Get the list of Contact custom fields

Authorizations:
jobadder_identity (readread_contact)

Responses

Response Schema: application/json
Array of objects (CustomFieldModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a Contact custom field

Authorizations:
jobadder_identity (readread_contact)
path Parameters
fieldId
required
integer <int32>

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Modify custom field list values

Authorizations:
jobadder_identity (manage_contact_custom)
path Parameters
fieldId
required
integer <int32>
Request Body schema: application/json
values
Array of strings

Available values for a list custom field

Responses

Response Schema: application/json
fieldId
required
integer <int32>
name
required
string
type
required
string
Enum: "Text" "List" "Date" "Lookup"
mandatory
boolean

Field is mandatory and a value must be provided

maxLength
integer <int32>

Maximum length of a text field

multiLine
boolean

Text field can contain a multi-line value

multiSelect
boolean

List field allows multiple selections

values
Array of strings

Available values for a list custom field

object (ModelLinks)

Request samples

Content type
application/json
{
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "fieldId": 1,
  • "name": "Text Field 1",
  • "type": "Text",
  • "mandatory": true,
  • "maxLength": 50,
  • "multiLine": true,
  • "multiSelect": false,
  • "values": [ ]
}

Get salutations (honorifics/titles)

Authorizations:
jobadder_identity (readread_contact)
query Parameters
name
string

Responses

Response Schema: application/json
Array of objects (NameModel)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a list of contact status definitions

Authorizations:
jobadder_identity (readread_contact)
query Parameters
statusId
Array of integers <int32>
name
string
active
boolean
default
boolean

Responses

Response Schema: application/json
Array of objects (StatusModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a contact status definition

Authorizations:
jobadder_identity (readread_contact)
path Parameters
statusId
required
integer <int32>

Responses

Response Schema: application/json
statusId
required
integer <int32>
name
required
string
active
boolean
default
boolean
object (ModelLinks)

Response samples

Content type
application/json
{
  • "statusId": 0,
  • "name": "string",
  • "active": true,
  • "default": true,
  • "links": {
    }
}

Notes

Find notes

Authorizations:
jobadder_identity (readread_note)
query Parameters
noteId
Array of strings <uuid>

Note Id

type
Array of strings

Note type

reference
Array of strings

Reference value used to identify a note or group of notes

createdAt
Array of strings

Search for notes created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for notes updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

candidateId
Array of integers <int32>

Candidate Id

companyId
Array of integers <int32>

Company Id

contactId
Array of integers <int32>

Contact Id

jobId
Array of integers <int32>

Job Id

requisitionId
Array of integers <int32>

Requisition Id

applicationId
Array of integers <int64>

Job Application Id

placementId
Array of integers <int32>

Placement Id

embed
Array of strings

Embed related resources.
Resources available to embed are: self

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

sort
Array of strings

Sort the results by one or multiple fields, prefix with "-" to sort descending.
Fields available for sorting are: type, createdAt, updatedAt

fields
Array of strings

Additional fields to include with the results.
Fields available to include are: text

Responses

Response Schema: application/json
Array of objects (NoteSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Add a note

Authorizations:
jobadder_identity (writewrite_note)
Request Body schema: application/json
type
required
string <= 50 characters
text
required
string

Note content

jobId
Array of integers <int32>
requisitionId
Array of integers <int32>
candidateId
Array of integers <int32>
applicationId
Array of integers <int64>
placementId
Array of integers <int32>
companyId
Array of integers <int32>
contactId
Array of integers <int32>
reference
string <= 200 characters

Optional reference string used to identify a note or group of notes

object (SubmitUserModel)

The user creating the note if not the authenticated user.
Specify either userId or email.

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string",
  • "jobId": [
    ],
  • "requisitionId": [
    ],
  • "candidateId": [
    ],
  • "applicationId": [
    ],
  • "placementId": [
    ],
  • "companyId": [
    ],
  • "contactId": [
    ],
  • "reference": "string",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get a note

Authorizations:
jobadder_identity (readread_note)
path Parameters
noteId
required
string <uuid>

Note Id

Responses

Response Schema: application/json
noteId
required
string <uuid>
type
string
source
string
text
string
subject
string
reference
string
readonly
boolean

This note cannot be updated

Array of objects (NoteAttachmentModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
object (NoteLinks)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>

Response samples

Content type
application/json
{
  • "noteId": "00000000-0000-0000-0000-000000000000",
  • "type": "string",
  • "source": "string",
  • "text": "string",
  • "subject": "string",
  • "reference": "string",
  • "readonly": true,
  • "attachments": [
    ],
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "links": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update a note

Authorizations:
jobadder_identity (writewrite_note)
path Parameters
noteId
required
string <uuid>
Request Body schema: application/json
type
string

Note type

text
string

Note content

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "text": "string"
}

Attachments

Add a single attachment

The file can be submitted either as multipart/form-data with a single part containing only the file, or as binary data

path Parameters
noteId
required
string <uuid>
Request Body schema: multipart/form-data
fileData
required
string <binary>

Responses

Get a note attachment

path Parameters
noteId
required
string <uuid>

Note Id

attachmentId
required
string <uuid>

Attachment Id

Responses

Response Schema: application/octet-stream
string <binary>

Folders

Find folders

Authorizations:
jobadder_identity (readread_folder)
query Parameters
folderId
Array of integers <int64>

Folder Id

jobId
Array of integers <int32>

Job Id

candidateId
Array of integers <int32>

Candidate Id

applicationId
Array of integers <int64>

Job Application Id

placementId
Array of integers <int32>

Placement Id

companyId
Array of integers <int32>

Company Id

contactId
Array of integers <int32>

Contact Id

userId
Array of integers <int32>

User Id - search for folders by owner or shared with the specified users

ownerUserId
Array of integers <int32>

User Id - search for folders by owner

sharedWithUserId
Array of integers <int32>

User Id - search folders shared with the specified users

createdAt
Array of strings

Search for folders created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedAt
Array of strings

Search for folders updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

fields
Array of strings

Additional fields to include with the results. Fields available to include are: sharedWith

embed
Array of strings

Embed related resources.
Resources available to embed are: self

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (FolderNameModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a folder

Authorizations:
jobadder_identity (readread_folder)
path Parameters
folderId
required
integer <int64>

Folder Id

Responses

Response Schema: application/json
folderId
required
integer <int64>
name
string
object (UserNameModel)
Array of objects (UserNameModel)
Array of objects (JobOrderTitleModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
createdAt
string <date-time>
updatedAt
string <date-time>
object (FolderLinks)

Response samples

Content type
application/json
{
  • "folderId": 0,
  • "name": "string",
  • "owner": {
    },
  • "sharedWith": [
    ],
  • "jobs": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Users

Find users

Authorizations:
jobadder_identity (readread_user)
query Parameters
userId
Array of integers <int32>
officeId
Array of integers <int32>
groupId
Array of integers <int32>
createdAt
Array of strings

Search for users created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedBy
Array of integers <int32>

User Id - search for jobs last updated by the specified user(s)

updatedAt
Array of strings

Search for users updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

include
Array of strings
Items Enum: "Inactive" "Deleted"
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (UserSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a user

Authorizations:
jobadder_identity (readread_user)
path Parameters
userId
required
integer <int32>

Responses

Response Schema: application/json
userId
required
integer <int32>
firstName
string
lastName
string
position
string
email
string
phone
string
mobile
string
inactive
boolean
deleted
boolean
mentionName
string
object (UserOfficeSummaryModel)
createdAt
string <date-time>
updatedAt
string <date-time>
timeZone
string
culture
string
admin
boolean
Array of objects (UserGroupSummaryModel)
object (UserLinks)

Response samples

Content type
application/json
{
  • "userId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "inactive": true,
  • "deleted": true,
  • "mentionName": "string",
  • "office": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "timeZone": "string",
  • "culture": "string",
  • "admin": true,
  • "userGroups": [
    ],
  • "links": {
    }
}

Get the current user

Authorizations:
jobadder_identity (readread_user)

Responses

Response Schema: application/json
userId
required
integer <int32>
firstName
string
lastName
string
position
string
email
string
phone
string
mobile
string
inactive
boolean
deleted
boolean
mentionName
string
object (UserOfficeSummaryModel)
createdAt
string <date-time>
updatedAt
string <date-time>
timeZone
string
culture
string
admin
boolean
Array of objects (UserGroupSummaryModel)
object (UserLinks)

Response samples

Content type
application/json
{
  • "userId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "email": "string",
  • "phone": "string",
  • "mobile": "string",
  • "inactive": true,
  • "deleted": true,
  • "mentionName": "string",
  • "office": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "timeZone": "string",
  • "culture": "string",
  • "admin": true,
  • "userGroups": [
    ],
  • "links": {
    }
}

Get a user photo

Authorizations:
jobadder_identity (readread_user)
path Parameters
userId
required
integer <int32>

User Id

Responses

Response Schema:
image/jpeg
image/jpeg
image/gif
image/png
string <binary>

Tasks

Find user tasks

Authorizations:
jobadder_identity (readread_usertask)
path Parameters
userId
required
integer <int32>
query Parameters
startAt
Array of strings

Search for tasks starting at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

include
Array of strings
Items Enum: "Old" "Complete"
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (UserTaskSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Interviews

Get all Interviews

Authorizations:
jobadder_identity (readread_interview)
path Parameters
userId
required
integer <int32>

User Id

query Parameters
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (InterviewSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Groups

Get user groups

Authorizations:
jobadder_identity (readread_usergroup)
path Parameters
userId
required
integer <int32>

User Id

Responses

Response Schema: application/json
Array of objects (UserGroupSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Groups

Find groups

Authorizations:
jobadder_identity (readread_usergroup)
query Parameters
groupId
Array of integers <int32>
userId
Array of integers <int32>
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (UserGroupSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a group

Authorizations:
jobadder_identity (readread_usergroup)
path Parameters
groupId
required
integer <int32>

Group Id

Responses

Response Schema: application/json
groupId
required
integer <int32>
name
required
string
Array of objects (UserSummaryModel)

Users belonging to the group

object (UserGroupLinks)

Response samples

Content type
application/json
{
  • "groupId": 0,
  • "name": "string",
  • "users": [
    ],
  • "links": {
    }
}

Users

Get users

Authorizations:
jobadder_identity (readread_user)
path Parameters
groupId
required
integer <int32>

Group Id

Responses

Response Schema: application/json
Array of objects (UserSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Offices

Find user offices

Authorizations:
jobadder_identity (readread_user)
query Parameters
officeId
Array of integers <int32>
userId
Array of integers <int32>
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (UserOfficeNameModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a user office

Authorizations:
jobadder_identity (readread_user)
path Parameters
officeId
required
integer <int32>

Office Id

Responses

Response Schema: application/json
officeId
required
integer <int32>
name
required
string
street
Array of strings
city
string
state
string
postalCode
string
country
string
countryCode
string
phone
string
fax
string
url
string
Array of objects (UserNameModel)

Users belonging to the office

object (UserOfficeLinks)

Response samples

Content type
application/json
{
  • "officeId": 0,
  • "name": "string",
  • "street": [
    ],
  • "city": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "countryCode": "string",
  • "phone": "string",
  • "fax": "string",
  • "url": "string",
  • "users": [
    ],
  • "links": {
    }
}

Users

Get users

Authorizations:
jobadder_identity (readread_user)
path Parameters
officeId
required
integer <int32>

Office Id

Responses

Response Schema: application/json
Array of objects (UserSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Tasks

Find user tasks

Authorizations:
jobadder_identity (readread_usertask)
query Parameters
userId
Array of integers <int32>

Search for tasks assigned to or owned by the specified users

startAt
Array of strings

Search for tasks starting at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

createdBy
Array of integers <int32>

User Id - search for companies created by the specified user(s)

createdAt
Array of strings

Search for tasks created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

updatedBy
Array of integers <int32>

User Id - search for companies last updated by the specified user(s)

updatedAt
Array of strings

Search for tasks updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

include
Array of strings
Items Enum: "Old" "Complete"
offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (UserTaskSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get a user task

Authorizations:
jobadder_identity (readread_usertask)
path Parameters
taskId
required
integer <int64>

Responses

Response Schema: application/json
taskId
integer <int64>
text
string
startAt
string <date-time>
endAt
string <date-time>
allDay
boolean
reminderMinutes
integer <int32>
complete
boolean
object (UserNameModel)
object (UserNameModel)
Array of objects (JobOrderTitleModel)
Array of objects (RequisitionSummaryModel)
Array of objects (CandidateNameModel)
Array of objects (JobApplicationSummaryModel)
Array of objects (PlacementSummaryModel)
Array of objects (CompanyNameModel)
Array of objects (ContactNameModel)
object (UserNameModel)
createdAt
string <date-time>
object (UserNameModel)
updatedAt
string <date-time>
object (UserTaskLinks)

Response samples

Content type
application/json
{
  • "taskId": 0,
  • "text": "string",
  • "startAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z",
  • "allDay": true,
  • "reminderMinutes": 0,
  • "complete": true,
  • "owner": {
    },
  • "assignedTo": {
    },
  • "jobs": [
    ],
  • "requisitions": [
    ],
  • "candidates": [
    ],
  • "applications": [
    ],
  • "placements": [
    ],
  • "companies": [
    ],
  • "contacts": [
    ],
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Interviews

Find interviews

Authorizations:
jobadder_identity (readread_interview)
query Parameters
interviewId
Array of integers <int32>
jobId
Array of integers <int32>
userId
Array of integers <int32>

User Id - search for internal/user interviewers

contactId
Array of integers <int32>

Contact Id - search for external/contact interviewers

candidateId
Array of integers <int32>

Candidate Id - search for interviewees by candidateId

applicationId
Array of integers <int64>

Application Id - search for interviewees by applicationId

type
Array of strings
Items Enum: "Internal" "External"
startAt
Array of strings

Search for interviews starting at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

endAt
Array of strings

Search for interviews ending at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

location
string
createdBy
Array of integers <int32>

User Id - search for interviews created by the specified user(s)

createdAt
Array of strings

Search for interviews created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

embed
Array of strings

Embed related resources.
Resources available to embed are: self, evaluations

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (InterviewSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Get an interview

Authorizations:
jobadder_identity (readread_interview)
path Parameters
interviewId
required
integer <int32>

Interview Id

applicationId
required
integer <int64>

Job Application Id

query Parameters
embed
Array of strings

Embed related resources.
Resources available to embed are: evaluations

Responses

Response Schema: application/json
interviewId
required
integer <int32>
type
required
string
Enum: "Internal" "External"
startAt
string <date-time>
endAt
string <date-time>
location
string
required
object (JobApplicationSummaryModel)
object (InterviewInterviewersModel)

Internal/user and External/contact interviewers

object (UserNameModel)
createdAt
string <date-time>
object (InterviewLinks)

Response samples

Content type
application/json
{
  • "interviewId": 0,
  • "type": "Internal",
  • "startAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "interviewee": {
    },
  • "interviewers": {
    },
  • "createdBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Evaluations

Get interview evaluations

Authorizations:
jobadder_identity (readread_interview)
path Parameters
interviewId
required
integer <int32>
applicationId
required
integer <int64>

Responses

Response Schema: application/json
Array of objects (InterviewEvaluationModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get an external/contact interview evaluation

Authorizations:
jobadder_identity (readread_interview)
path Parameters
interviewId
required
integer <int32>
applicationId
required
integer <int64>
contactId
required
integer <int32>

Responses

Response Schema: application/json
object (UserNameModel)
object (ContactNameModel)
expiresAt
string <date-time>
hasReplied
boolean
comments
string
Array of objects (InterviewEvaluationRatingModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "user": {
    },
  • "contact": {
    },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "hasReplied": true,
  • "comments": "string",
  • "rating": [
    ],
  • "links": {
    }
}

Submit an external/contact interview evaluation

Authorizations:
jobadder_identity (writewrite_interview)
path Parameters
interviewId
required
integer <int32>
applicationId
required
integer <int64>
contactId
required
integer <int32>
Request Body schema: application/json
comments
string
Array of objects (SubmitInterviewEvaluationRatingModel)

Responses

Response Schema: application/json
object (UserNameModel)
object (ContactNameModel)
expiresAt
string <date-time>
hasReplied
boolean
comments
string
Array of objects (InterviewEvaluationRatingModel)
object (ModelLinks)

Request samples

Content type
application/json
{
  • "comments": "string",
  • "rating": [
    ]
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "contact": {
    },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "hasReplied": true,
  • "comments": "string",
  • "rating": [
    ],
  • "links": {
    }
}

Get an internal/user interview evaluation

Authorizations:
jobadder_identity (readread_interview)
path Parameters
interviewId
required
integer <int32>
applicationId
required
integer <int64>
userId
required
integer <int32>

Responses

Response Schema: application/json
object (UserNameModel)
object (ContactNameModel)
expiresAt
string <date-time>
hasReplied
boolean
comments
string
Array of objects (InterviewEvaluationRatingModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "user": {
    },
  • "contact": {
    },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "hasReplied": true,
  • "comments": "string",
  • "rating": [
    ],
  • "links": {
    }
}

Submit an internal/user interview evaluation

Authorizations:
jobadder_identity (writewrite_interview)
path Parameters
interviewId
required
integer <int32>
applicationId
required
integer <int64>
userId
required
integer <int32>
Request Body schema: application/json
comments
string
Array of objects (SubmitInterviewEvaluationRatingModel)

Responses

Response Schema: application/json
object (UserNameModel)
object (ContactNameModel)
expiresAt
string <date-time>
hasReplied
boolean
comments
string
Array of objects (InterviewEvaluationRatingModel)
object (ModelLinks)

Request samples

Content type
application/json
{
  • "comments": "string",
  • "rating": [
    ]
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "contact": {
    },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "hasReplied": true,
  • "comments": "string",
  • "rating": [
    ],
  • "links": {
    }
}

Categories

Find categories

query Parameters
categoryId
Array of integers <int32>
embed
Array of strings
Items Enum: "SubCategories" "Skills"

Responses

Response Schema: application/json
Array of objects (CategoryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Countries

Find countries

query Parameters
code
Array of strings

Responses

Response Schema: application/json
Array of objects (CountryModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Locations

Find locations

query Parameters
locationId
Array of integers <int32>
embed
Array of strings
Items Value: "Areas"

Responses

Response Schema: application/json
Array of objects (LocationModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Work Types

Find work types

query Parameters
workTypeId
Array of integers <int32>

Responses

Response Schema: application/json
Array of objects (WorkTypeModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Search

Search by email address.

Find candidates, contacts or users by email address.

Authorizations:
jobadder_identity (readread_candidateread_contactread_user)
query Parameters
email
string

Email address to search for.

Responses

Response Schema: application/json
Array of objects (CandidateMatchedByEmailModel)

Top 5 most recently updated matching candidates

Array of objects (ContactMatchedByEmailModel)

Top 5 most recently updated matching contacts

Array of objects (UserMatchedByEmailModel)

Top 5 most recently updated matching users

Response samples

Content type
application/json
{
  • "candidates": [
    ],
  • "contacts": [
    ],
  • "users": [
    ]
}

Search by phone number.

Find candidates, contacts, companies or users by phone number.

Authorizations:
jobadder_identity (readread_candidateread_contactread_companyread_user)
query Parameters
e164
string

Responses

Response Schema: application/json
Array of objects (CandidateMatchedByPhoneModel)

Top 5 most recently updated matching candidates

Array of objects (ContactMatchedByPhoneModel)

Top 5 most recently updated matching contacts

Array of objects (CompanyMatchedByPhoneModel)

Top 5 most recently updated matching companies

Array of objects (UserMatchedByPhoneModel)

Top 5 most recently updated matching users

quality
string
Enum: "Exact" "National" "Subscriber"

Match quality

Response samples

Content type
application/json
{
  • "candidates": [
    ],
  • "contacts": [
    ],
  • "companies": [
    ],
  • "users": [
    ],
  • "quality": "Exact"
}

Actions

Find partner actions

Authorizations:
jobadder_identity (partner_ui_action)
query Parameters
actionType
Array of strings
Items Enum: "Job" "JobAd" "Candidate" "JobApplication" "Placement" "Company" "Contact"

Type of action

actionId
Array of strings <uuid>

Unique identifier for partner actions

reference
Array of strings

Partner supplied unique reference for the action

Responses

Response Schema: application/json
Array of objects (PartnerActionModel)

Partner actions

object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get a partner action

Authorizations:
jobadder_identity (partner_ui_action)
path Parameters
act
required
string <uuid>

Action Id

Responses

Response Schema: application/json
actionId
string <uuid>

Unique identifier for the partner action

actionType
string
Enum: "Job" "JobAd" "Candidate" "JobApplication" "Placement" "Company" "Contact"

Type of action

actionName
string

Menu item label that will appear to the end-user

reference
string

Unique partner defined reference/identifier for the action

url
string

URL to open after the action is selected and assigned the "Submitted" stage.

urlType
string
Enum: "Popup" "Page"

Present url as either an embedded popup ("Popup", the default), or open a new window or tab ("Page")

allowResubmit
boolean

Allow resources to be resubmitted to an action.

object (PartnerActionFilterModel)
webhookData
object

Additional data that will be included with the webhook notification

createdAt
string <date-time>

Date the partner action was added

updatedAt
string <date-time>

Date the partner action was last updated

object (ModelLinks)

Response samples

Content type
application/json
{
  • "actionId": "00000000-0000-0000-0000-000000000000",
  • "actionType": "Job",
  • "actionName": "string",
  • "reference": "string",
  • "url": "string",
  • "urlType": "Popup",
  • "allowResubmit": true,
  • "actionFilter": {
    },
  • "webhookData": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Update a partner action

Authorizations:
jobadder_identity (partner_ui_action)
path Parameters
act
required
string <uuid>

Action Id

Request Body schema: application/json
actionName
required
string <= 100 characters

Menu item label that will appear to the end-user

reference
string <= 100 characters

Unique partner defined reference/identifier for the action

url
string <= 500 characters

URL to open after the action is selected and assigned the "Submitted" stage.
Templates parameters can be used in the URL to identify the resource submitted to the action

`{userId}`Replaced with the User Id of the user performing the action
`{jobId}`Replaced with the Job Id
`{adId}`Replaced with the Job Ad Id
`{candidateId}`Replaced with the Candidate Id
`{applicationId}`Replaced with the Job Application Id
`{placementId}`Replaced with the Placement Id
`{companyId}`Replaced with the Company Id
`{contactId}`Replaced with the Contact Id
urlType
string
Enum: "Popup" "Page"

Present url as either an embedded popup ("Popup", the default), or open a new window or tab ("Page")

allowResubmit
boolean

Allow resources to be resubmitted to an action.

object (PartnerActionFilterModel)
webhookData
object

Additional data to include with the webhook notification

Responses

Response Schema: application/json
actionId
string <uuid>

Unique identifier for the partner action

actionType
string
Enum: "Job" "JobAd" "Candidate" "JobApplication" "Placement" "Company" "Contact"

Type of action

actionName
string

Menu item label that will appear to the end-user

reference
string

Unique partner defined reference/identifier for the action

url
string

URL to open after the action is selected and assigned the "Submitted" stage.

urlType
string
Enum: "Popup" "Page"

Present url as either an embedded popup ("Popup", the default), or open a new window or tab ("Page")

allowResubmit
boolean

Allow resources to be resubmitted to an action.

object (PartnerActionFilterModel)
webhookData
object

Additional data that will be included with the webhook notification

createdAt
string <date-time>

Date the partner action was added

updatedAt
string <date-time>

Date the partner action was last updated

object (ModelLinks)

Request samples

Content type
application/json
{
  • "actionName": "string",
  • "reference": "string",
  • "url": "string",
  • "urlType": "Popup",
  • "allowResubmit": true,
  • "actionFilter": {
    },
  • "webhookData": { }
}

Response samples

Content type
application/json
{
  • "actionId": "00000000-0000-0000-0000-000000000000",
  • "actionType": "Job",
  • "actionName": "string",
  • "reference": "string",
  • "url": "string",
  • "urlType": "Popup",
  • "allowResubmit": true,
  • "actionFilter": {
    },
  • "webhookData": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Add a partner action

Authorizations:
jobadder_identity (partner_ui_action)
path Parameters
act
required
string
Enum: "Job" "JobAd" "Candidate" "JobApplication" "Placement" "Company" "Contact"

Action type. The type cannot be changed once assigned.

Request Body schema: application/json
actionName
required
string <= 100 characters

Menu item label that will appear to the end-user

reference
string <= 100 characters

Unique partner defined reference/identifier for the action

url
string <= 500 characters

URL to open after the action is selected and assigned the "Submitted" stage.
Templates parameters can be used in the URL to identify the resource submitted to the action

`{userId}`Replaced with the User Id of the user performing the action
`{jobId}`Replaced with the Job Id
`{adId}`Replaced with the Job Ad Id
`{candidateId}`Replaced with the Candidate Id
`{applicationId}`Replaced with the Job Application Id
`{placementId}`Replaced with the Placement Id
`{companyId}`Replaced with the Company Id
`{contactId}`Replaced with the Contact Id
urlType
string
Enum: "Popup" "Page"

Present url as either an embedded popup ("Popup", the default), or open a new window or tab ("Page")

allowResubmit
boolean

Allow resources to be resubmitted to an action.

object (PartnerActionFilterModel)
webhookData
object

Additional data to include with the webhook notification

Responses

Response Schema: application/json
actionId
string <uuid>

Unique identifier for the partner action

actionType
string
Enum: "Job" "JobAd" "Candidate" "JobApplication" "Placement" "Company" "Contact"

Type of action

actionName
string

Menu item label that will appear to the end-user

reference
string

Unique partner defined reference/identifier for the action

url
string

URL to open after the action is selected and assigned the "Submitted" stage.

urlType
string
Enum: "Popup" "Page"

Present url as either an embedded popup ("Popup", the default), or open a new window or tab ("Page")

allowResubmit
boolean

Allow resources to be resubmitted to an action.

object (PartnerActionFilterModel)
webhookData
object

Additional data that will be included with the webhook notification

createdAt
string <date-time>

Date the partner action was added

updatedAt
string <date-time>

Date the partner action was last updated

object (ModelLinks)

Request samples

Content type
application/json
{
  • "actionName": "string",
  • "reference": "string",
  • "url": "string",
  • "urlType": "Popup",
  • "allowResubmit": true,
  • "actionFilter": {
    },
  • "webhookData": { }
}

Response samples

Content type
application/json
{
  • "actionId": "00000000-0000-0000-0000-000000000000",
  • "actionType": "Job",
  • "actionName": "string",
  • "reference": "string",
  • "url": "string",
  • "urlType": "Popup",
  • "allowResubmit": true,
  • "actionFilter": {
    },
  • "webhookData": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Delete a partner action

Authorizations:
jobadder_identity (partner_ui_action)
path Parameters
act
required
string <uuid>

Action Id

Responses

Candidates

Find candidates submitted to an action

Authorizations:
jobadder_identity (partner_ui_actionreadread_candidate)
path Parameters
actionId
required
string <uuid>

Action Id

query Parameters
stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CandidateSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Complete a candidate action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_candidate)
path Parameters
actionId
required
string <uuid>

Action Id

candidateId
required
integer <int32>

Candidate Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Update candidate action progress

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_candidate)
path Parameters
actionId
required
string <uuid>

Action Id

candidateId
required
integer <int32>

Candidate Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Reject a candidate action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_candidate)
path Parameters
actionId
required
string <uuid>

Action Id

candidateId
required
integer <int32>

Candidate Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Companies

Find companies submitted to an action

Authorizations:
jobadder_identity (partner_ui_actionreadread_company)
path Parameters
actionId
required
string <uuid>

Action Id

query Parameters
stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (CompanySummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Complete a company action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_company)
path Parameters
actionId
required
string <uuid>

Action Id

companyId
required
integer <int32>

Company Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Update company action progress

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_company)
path Parameters
actionId
required
string <uuid>

Action Id

companyId
required
integer <int32>

Company Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Reject a company action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_company)
path Parameters
actionId
required
string <uuid>

Action Id

companyId
required
integer <int32>

Company Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Contacts

Find contacts submitted to an action

Authorizations:
jobadder_identity (partner_ui_actionreadread_contact)
path Parameters
actionId
required
string <uuid>

Action Id

query Parameters
stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (ContactSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Complete a contact action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_contact)
path Parameters
actionId
required
string <uuid>

Action Id

contactId
required
integer <int32>

Contact Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Update contact action progress

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_contact)
path Parameters
actionId
required
string <uuid>

Action Id

contactId
required
integer <int32>

Contact Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Reject a contact action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_contact)
path Parameters
actionId
required
string <uuid>

Action Id

contactId
required
integer <int32>

Contact Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Job Ads

Find job ads submitted to an action

Authorizations:
jobadder_identity (partner_ui_actionreadread_jobad)
path Parameters
actionId
required
string <uuid>

Action Id

query Parameters
stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobAdSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Complete a job ad action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_jobad)
path Parameters
actionId
required
string <uuid>

Action Id

adId
required
integer <int32>

Job Ad Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Update job ad action progress

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_jobad)
path Parameters
actionId
required
string <uuid>

Action Id

adId
required
integer <int32>

Job Ad Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Reject a job ad action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_jobad)
path Parameters
actionId
required
string <uuid>

Action Id

adId
required
integer <int32>

Job Ad Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Job Applications

Find job applications submitted to an action

Authorizations:
jobadder_identity (partner_ui_actionreadread_jobapplication)
path Parameters
actionId
required
string <uuid>

Action Id

query Parameters
stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobApplicationSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Complete a job application action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_jobapplication)
path Parameters
actionId
required
string <uuid>

Action Id

applicationId
required
integer <int64>

Job Application Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Update job application action progress

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_jobapplication)
path Parameters
actionId
required
string <uuid>

Action Id

applicationId
required
integer <int64>

Job Application Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Reject a job application action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_jobapplication)
path Parameters
actionId
required
string <uuid>

Action Id

applicationId
required
integer <int64>

Job Application Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Jobs

Find jobs submitted to an action

Authorizations:
jobadder_identity (partner_ui_actionreadread_job)
path Parameters
actionId
required
string <uuid>

Action Id

query Parameters
stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (JobOrderSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Complete a job action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_job)
path Parameters
actionId
required
string <uuid>

Action Id

jobId
required
integer <int32>

Job Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Update job action progress

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_job)
path Parameters
actionId
required
string <uuid>

Action Id

jobId
required
integer <int32>

Job Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Reject a job action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_job)
path Parameters
actionId
required
string <uuid>

Action Id

jobId
required
integer <int32>

Job Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Placements

Find placements submitted to an action

Authorizations:
jobadder_identity (partner_ui_actionreadread_placement)
path Parameters
actionId
required
string <uuid>

Action Id

query Parameters
stage
Array of strings
Items Enum: "Submitted" "InProgress" "Completed" "Rejected" "Cancelled"

Include partner actions at a specific stage

submittedAt
Array of strings

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

offset
integer <int32>

The index of the first entry to return from the resource collection

limit
integer <int32> [ 0 .. 1000 ]

The maximum number of entries to return.
Setting to 0 will return only the total count of matching resources.

Responses

Response Schema: application/json
Array of objects (PlacementSummaryModel)
totalCount
required
integer <int32>
object (PageLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "links": {
    }
}

Complete a placement action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_placement)
path Parameters
actionId
required
string <uuid>

Action Id

placementId
required
integer <int32>

Placement Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Update placement action progress

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_placement)
path Parameters
actionId
required
string <uuid>

Action Id

placementId
required
integer <int32>

Placement Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Reject a placement action

Authorizations:
jobadder_identity (partner_ui_actionwritewrite_placement)
path Parameters
actionId
required
string <uuid>

Action Id

placementId
required
integer <int32>

Placement Id

Request Body schema: application/json
status
string <= 100 characters

Optional partner defined action status/progress

object (PartnerActionResultCommandModel)

Optional complete or partial results for a partner action

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "result": {
    }
}

Webhooks

Find webhooks

Authorizations:
jobadder_identity (offline_access)
query Parameters
status
Array of strings
Items Enum: "Enabled" "Disabled" "Suspended" "Failed"
events
Array of strings
Items Enum: "job_status_changed" "job_partner_action" "jobad_posted" "jobad_expired" "jobad_partner_action" "candidate_status_changed" "candidate_partner_action" "jobapplication_status_changed" "jobapplication_partner_action" "placement_approved" "placement_status_changed" "placement_partner_action" "company_status_changed" "company_partner_action" "contact_status_changed" "contact_partner_action" "interview_scheduled" "interview_evaluation_submitted" "folder_job_added" "folder_job_removed" "folder_candidate_added" "folder_candidate_removed" "folder_jobapplication_added" "folder_jobapplication_removed" "folder_placement_added" "folder_placement_removed" "folder_company_added" "folder_company_removed" "folder_contact_added" "folder_contact_removed"

Responses

Response Schema: application/json
Array of objects (WebhookModel)
object (ModelLinks)

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Add a new webhook

Authorizations:
jobadder_identity (offline_access)
Request Body schema: application/json
name
required
string <= 100 characters
events
required
Array of strings
Items Enum: "job_status_changed" "job_partner_action" "jobad_posted" "jobad_expired" "jobad_partner_action" "candidate_status_changed" "candidate_partner_action" "jobapplication_status_changed" "jobapplication_partner_action" "placement_approved" "placement_status_changed" "placement_partner_action" "company_status_changed" "company_partner_action" "contact_status_changed" "contact_partner_action" "interview_scheduled" "interview_evaluation_submitted" "folder_job_added" "folder_job_removed" "folder_candidate_added" "folder_candidate_removed" "folder_jobapplication_added" "folder_jobapplication_removed" "folder_placement_added" "folder_placement_removed" "folder_company_added" "folder_company_removed" "folder_contact_added" "folder_contact_removed"
object (SubmitWebhookEventFilterModel)
url
required
string

Target URL that will listen for incoming HTTP POST notification messages.

authorization
string

Optional authorization header to include with the HTTP POST notification.

status
string
Enum: "Enabled" "Disabled" "Suspended"

Responses

Response Schema: application/json
webhookId
string <uuid>
name
string
status
string
Enum: "Enabled" "Disabled" "Suspended" "Failed"
url
string
events
Array of strings
Items Enum: "job_status_changed" "job_partner_action" "jobad_posted" "jobad_expired" "jobad_partner_action" "candidate_status_changed" "candidate_partner_action" "jobapplication_status_changed" "jobapplication_partner_action" "placement_approved" "placement_status_changed" "placement_partner_action" "company_status_changed" "company_partner_action" "contact_status_changed" "contact_partner_action" "interview_scheduled" "interview_evaluation_submitted" "folder_job_added" "folder_job_removed" "folder_candidate_added" "folder_candidate_removed" "folder_jobapplication_added" "folder_jobapplication_removed" "folder_placement_added" "folder_placement_removed" "folder_company_added" "folder_company_removed" "folder_contact_added" "folder_contact_removed"
object (WebhookEventFilterModel)
createdAt
string <date-time>
updatedAt
string <date-time>
enabledAt
string <date-time>
disabledAt
string <date-time>
suspendedAt
string <date-time>
failedAt
string <date-time>
object (ModelLinks)

Request samples

Content type
application/json
{
  • "name": "string",
  • "events": [
    ],
  • "eventFilters": {
    },
  • "url": "string",
  • "authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
  • "status": "Enabled"
}

Response samples

Content type
application/json
{
  • "webhookId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "status": "Enabled",
  • "url": "string",
  • "events": [
    ],
  • "eventFilters": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "enabledAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "suspendedAt": "2019-08-24T14:15:22Z",
  • "failedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Get a webhook

Authorizations:
jobadder_identity (offline_access)
path Parameters
webhookId
required
string <uuid>

Responses

Response Schema: application/json
webhookId
string <uuid>
name
string
status
string
Enum: "Enabled" "Disabled" "Suspended" "Failed"
url
string
events
Array of strings
Items Enum: "job_status_changed" "job_partner_action" "jobad_posted" "jobad_expired" "jobad_partner_action" "candidate_status_changed" "candidate_partner_action" "jobapplication_status_changed" "jobapplication_partner_action" "placement_approved" "placement_status_changed" "placement_partner_action" "company_status_changed" "company_partner_action" "contact_status_changed" "contact_partner_action" "interview_scheduled" "interview_evaluation_submitted" "folder_job_added" "folder_job_removed" "folder_candidate_added" "folder_candidate_removed" "folder_jobapplication_added" "folder_jobapplication_removed" "folder_placement_added" "folder_placement_removed" "folder_company_added" "folder_company_removed" "folder_contact_added" "folder_contact_removed"
object (WebhookEventFilterModel)
createdAt
string <date-time>
updatedAt
string <date-time>
enabledAt
string <date-time>
disabledAt
string <date-time>
suspendedAt
string <date-time>
failedAt
string <date-time>
object (ModelLinks)

Response samples

Content type
application/json
{
  • "webhookId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "status": "Enabled",
  • "url": "string",
  • "events": [
    ],
  • "eventFilters": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "enabledAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "suspendedAt": "2019-08-24T14:15:22Z",
  • "failedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Update an existing webhook

Authorizations:
jobadder_identity (offline_access)
path Parameters
webhookId
required
string <uuid>
Request Body schema: application/json
name
required
string <= 100 characters
events
required
Array of strings
Items Enum: "job_status_changed" "job_partner_action" "jobad_posted" "jobad_expired" "jobad_partner_action" "candidate_status_changed" "candidate_partner_action" "jobapplication_status_changed" "jobapplication_partner_action" "placement_approved" "placement_status_changed" "placement_partner_action" "company_status_changed" "company_partner_action" "contact_status_changed" "contact_partner_action" "interview_scheduled" "interview_evaluation_submitted" "folder_job_added" "folder_job_removed" "folder_candidate_added" "folder_candidate_removed" "folder_jobapplication_added" "folder_jobapplication_removed" "folder_placement_added" "folder_placement_removed" "folder_company_added" "folder_company_removed" "folder_contact_added" "folder_contact_removed"
object (SubmitWebhookEventFilterModel)
url
string

Target URL that will listen for incoming HTTP POST notification messages.

authorization
string

Optional authorization header to include with the HTTP POST notification.

status
string
Enum: "Enabled" "Disabled" "Suspended"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "events": [
    ],
  • "eventFilters": {
    },
  • "url": "string",
  • "authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
  • "status": "Enabled"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Delete a webhook

Authorizations:
jobadder_identity (offline_access)
path Parameters
webhookId
required
string <uuid>

Webhook Id

Responses