Jobs
Job Sync enables the user to manage jobs (view, create, update and delete jobs) in the Phenom database.
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/v1/jobs
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'GET /jobs-api/v1/jobs
This API retrieves a list of jobs based on search.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | query | string | false |
| locale | query | string | false |
| category | query | string | false |
| siteType | query | string | false |
| offset | query | string | false |
| limit | query | string | false |
Response
OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"offset": {
"type": "integer",
"description": "Parameter defines from which point to query for jobs."
},
"limit": {
"type": "integer",
"description": "Parameter defines how many jobs to query."
},
"totalRecordsCount": {
"type": "integer",
"description": "Total number of jobs for given query."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}
]OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"offset": {
"type": "integer",
"description": "Parameter defines from which point to query for jobs."
},
"limit": {
"type": "integer",
"description": "Parameter defines how many jobs to query."
},
"totalRecordsCount": {
"type": "integer",
"description": "Total number of jobs for given query."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Internal Server Error
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | JobsListSuccessResponse |
| 201 | OK | JobsListSuccessResponse |
| 400 | Bad Request | ErrorResponse |
| 500 | Internal Server Error | ErrorResponse |
post
copied!# You can also use wgetcurl -X POST https://api-qa.phenompro.com/jobs-api/v1/jobs
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'POST /jobs-api/v1/jobs
This API creates a Job in Phenom that reflects in their respective career site.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Body Parameter
copied![
{
"type": "object",
"properties": {
"job": {
"JobRequestDTO": {
"required": {
"0": "description",
"1": "jobId",
"2": "reqId",
"3": "title"
},
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
}
}
}
},
"postings": {
"type": "array",
"items": {
"PostingDTO": {
"type": "object",
"required": {
"0": "locale",
"1": "siteType"
},
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"siteType": {
"type": "string",
"description": "SiteType of the job."
},
"category": {
"type": "string",
"description": "Category of the job."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"description": {
"type": "string",
"description": "Description of the job."
},
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
}
}
}
}
}
}
}
]Request Parameters
| Type | Name |
|---|---|
| application/json | JobVariantsRequestDTO |
Response
OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"offset": {
"type": "integer",
"description": "Parameter defines from which point to query for jobs."
},
"limit": {
"type": "integer",
"description": "Parameter defines how many jobs to query."
},
"totalRecordsCount": {
"type": "integer",
"description": "Total number of jobs for given query."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}
]OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"offset": {
"type": "integer",
"description": "Parameter defines from which point to query for jobs."
},
"limit": {
"type": "integer",
"description": "Parameter defines how many jobs to query."
},
"totalRecordsCount": {
"type": "integer",
"description": "Total number of jobs for given query."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Internal Server Error
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | JobsListSuccessResponse |
| 201 | OK | JobsListSuccessResponse |
| 400 | Bad Request | ErrorResponse |
| 500 | Internal Server Error | ErrorResponse |
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/v1/jobs/{referenceId}
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'GET /jobs-api/v1/jobs/{referenceId}
This API retrieves all the details of a job using its unique reference ID.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| referenceId | path | string | true |
Response
OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"data": {
"type": "object",
"description": "Job.",
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
]OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"data": {
"type": "object",
"description": "Job.",
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Internal Server Error
copied![
{
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "Error Code."
},
"errorDesc": {
"type": "string",
"description": "Error Description."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | JobSuccessResponse |
| 201 | OK | JobSuccessResponse |
| 400 | Bad Request | ErrorResponse |
| 500 | Internal Server Error | CustomError |
delete
copied!# You can also use wgetcurl -X DELETE https://api-qa.phenompro.com/jobs-api/v1/jobs/{referenceId}
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'DELETE /jobs-api/v1/jobs/{referenceId}
This API is used to delete a job using its unique reference ID.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| referenceId | path | string | true |
Response
OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"data": {
"type": "object",
"description": "Job.",
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
]OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"data": {
"type": "object",
"description": "Job.",
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Internal Server Error
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | JobSuccessResponse |
| 201 | OK | JobSuccessResponse |
| 400 | Bad Request | ErrorResponse |
| 500 | Internal Server Error | ErrorResponse |
patch
copied!# You can also use wgetcurl -X PATCH https://api-qa.phenompro.com/jobs-api/v1/jobs/{referenceId}
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'PATCH /jobs-api/v1/jobs/{referenceId}
This API is used to update a job using its unique reference ID.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Body Parameter
copied![
{
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"description": {
"type": "string",
"description": "ATS job description."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
}
}
}
]Parameters
| Name | In | Type | Required |
|---|---|---|---|
| referenceId | path | string | true |
Request Parameters
| Type | Name |
|---|---|
| application/json | JobPostingRequestDTO |
Response
OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"data": {
"type": "object",
"description": "Job.",
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
]OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"data": {
"type": "object",
"description": "Job.",
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Internal Server Error
copied![
{
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "Error Code."
},
"errorDesc": {
"type": "string",
"description": "Error Description."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | JobSuccessResponse |
| 201 | OK | JobSuccessResponse |
| 400 | Bad Request | ErrorResponse |
| 500 | Internal Server Error | CustomError |
delete
copied!# You can also use wgetcurl -X DELETE https://api-qa.phenompro.com/jobs-api/v1/jobs/variants/{jobId}
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'DELETE /jobs-api/v1/jobs/variants/{jobId}
This API is used to delete all job variants for a given job ID.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | path | string | true |
Response
OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the response."
},
"message": {
"type": "string",
"description": "Response message."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the response."
},
"message": {
"type": "string",
"description": "Response message."
}
}
}
]Internal Server Error
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the response."
},
"message": {
"type": "string",
"description": "Response message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | StandardApiResponse |
| 400 | Bad Request | StandardErrorResponse |
| 500 | Internal Server Error | StandardErrorResponse |
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/v1/closedJobs
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'GET /jobs-api/v1/closedJobs
This API retrieves a list of closed jobs based on search or query parameters like locale, site type, job ID, and category.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | query | string | false |
| locale | query | string | false |
| category | query | string | false |
| siteType | query | string | false |
| offset | query | string | false |
| limit | query | string | false |
Response
OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"offset": {
"type": "integer",
"description": "Parameter defines from which point to query for jobs."
},
"limit": {
"type": "integer",
"description": "Parameter defines how many jobs to query."
},
"totalRecordsCount": {
"type": "integer",
"description": "Total number of jobs for given query."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}
]OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"offset": {
"type": "integer",
"description": "Parameter defines from which point to query for jobs."
},
"limit": {
"type": "integer",
"description": "Parameter defines how many jobs to query."
},
"totalRecordsCount": {
"type": "integer",
"description": "Total number of jobs for given query."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Internal Server Error
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | JobsListSuccessResponse |
| 201 | OK | JobsListSuccessResponse |
| 400 | Bad Request | ErrorResponse |
| 500 | Internal Server Error | ErrorResponse |
patch
copied!# You can also use wgetcurl -X PATCH https://api-qa.phenompro.com/jobs-api/v1/jobs/multiple-variants
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'PATCH /jobs-api/v1/jobs/multiple-variants
This API is used to update multiple job variants based on the request body.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Body Parameter
copied![
{}
]Request Parameters
| Type | Name |
|---|---|
| application/json | JobPostingRequestDTO |
Response
OK
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the response."
},
"message": {
"type": "string",
"description": "Response message."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": {
"0": "category"
},
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": {
"0": "recruiterEmail",
"1": "recruiterName"
},
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": {
"0": "hiringManagerEmail",
"1": "hiringManagerName"
},
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the response."
},
"message": {
"type": "string",
"description": "Response message."
}
}
}
]Internal Server Error
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the response."
},
"message": {
"type": "string",
"description": "Response message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | StandardApiResponse |
| 400 | Bad Request | StandardErrorResponse |
| 500 | Internal Server Error | StandardErrorResponse |
Job Activities
These API's allows you to perform activities on Jobs
Hiring Team
These API's allows you to perform operations on Hiring Team.
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/activities/v1/jobs/{jobId}/hiring-team
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'
-H 'x-ph-userid: string'GET /jobs-api/activities/v1/jobs/{jobId}/hiring-team
This API fetches the Hiring Team for the mentioned JobId.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
| x-ph-userid | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | path | string | true |
Response
200 response
copied![
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hiringTeamList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"description": "Role or position of a member in the hiring team."
},
"createdDate": {
"type": "number",
"description": "Timestamp indicating when the member was created in the hiring team."
},
"read": {
"type": "string",
"description": "Read status or permission of the member."
},
"name": {
"type": "string",
"description": "Name of the member in the hiring team."
},
"emailId": {
"type": "string",
"description": "Email address of the member in the hiring team."
},
"source": {
"type": "string",
"description": "Source or origin of the member in the hiring team."
}
},
"required": {
"0": "role",
"1": "createdDate",
"2": "read",
"3": "name",
"4": "emailId",
"5": "source"
}
}
}
},
"required": {
"0": "hiringTeamList"
}
},
"description": "Array of objects containing information about the hiring team members."
},
"message": {
"type": "string",
"description": "A human readable message providing details about the operation result."
},
"status": {
"type": "string",
"description": "Indicates the status of the operation (e.g., success, failure)."
},
"timestamp": {
"type": "string",
"description": "Timestamp indicating when the operation was performed."
}
},
"required": {
"0": "data",
"1": "message",
"2": "status",
"3": "timestamp"
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | HiringTeam |
patch
copied!# You can also use wgetcurl -X PATCH https://api-qa.phenompro.com/jobs-api/activities/v1/jobs/{jobId}/hiring-team
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'
-H 'x-ph-userid: string'PATCH /jobs-api/activities/v1/jobs/{jobId}/hiring-team
Updates the Hiring Team for the Job with given JobId.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
| x-ph-userid | header | string | true |
Body Parameter
copied![
{
"type": "object",
"properties": {
"opType": {
"type": "string",
"description": "The operation type for updating the hiring team."
},
"hiringTeamList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of a member in the hiring team."
},
"emailId": {
"type": "string",
"description": "The email address of a member in the hiring team."
},
"role": {
"type": "string",
"description": "The role of a member in the hiring team."
}
},
"required": {
"0": "name",
"1": "emailId",
"2": "role"
},
"description": "Details of a member in the hiring team."
},
"description": "An array containing details of members in the hiring team for the update."
}
},
"required": {
"0": "opType",
"1": "hiringTeamList"
},
"description": "Request object for updating the hiring team of jobs."
}
]Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | path | string | true |
Request Parameters
| Type | Name |
|---|---|
| application/json | UpdateJobsHiringTeamRequest |
Response
200 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the update operation on the hiring team."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the update operation."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the update operation on the hiring team occurred."
}
},
"description": "Response object for a successful update of the hiring team."
}
]404 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating that the requested resource was not found."
},
"message": {
"type": "string",
"description": "A human readable message providing details about the not found error."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the not found error occurred."
}
},
"required": {
"0": "status",
"1": "message",
"2": "timestamp"
},
"description": "Response object for an error when the requested resource is not found."
}
]500 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating an internal server error."
},
"message": {
"type": "string",
"description": "A human readable message providing details about the internal server error."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the internal server error occurred."
}
},
"required": {
"0": "status",
"1": "message",
"2": "timestamp"
},
"description": "Response object for an internal server error."
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | UpdateHiringTeamResponse |
| 404 | 404 response | NotFoundError |
| 500 | 500 response | InternalServerErrorResponse |
Job Attachments
These API's allows you to fetch Job attachments.
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/activities/v1/jobs/{jobId}/attachments
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'
-H 'x-ph-userid: string'GET /jobs-api/activities/v1/jobs/{jobId}/attachments
Fetches Job Attachments for the given JobId.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
| x-ph-userid | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | path | string | true |
Response
200 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the operation to fetch job attachments."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the fetch operation."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the fetch operation for job attachments occurred."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachmentDate": {
"type": "string",
"description": "The date when the attachment was added to the job."
},
"createdByUserName": {
"type": "string",
"description": "The name of the user who added the attachment to the job."
},
"attachmentName": {
"type": "string",
"description": "The name of the attachment."
},
"attachmentId": {
"type": "string",
"description": "The unique identifier for the attachment."
},
"createdByUserEmail": {
"type": "string",
"description": "The email address of the user who added the attachment to the job."
}
}
},
"description": "An array containing details of job attachments."
}
},
"description": "Response object for a successful fetch of job attachments."
}
]No Data found
copied![
{
"type": "object",
"description": "Response indicating no data has been found.",
"properties": {}
}
]Bad Request Response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating a bad request."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "The timestamp when the error occurred."
},
"errorAPI": {
"type": "string",
"description": "The specific API on which the error has occurred."
},
"message": {
"type": "string",
"description": "A human readable error message describing the issue."
}
}
}
}
},
"description": "Response object for a bad request, containing details about errors."
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | GetJobAttachmentsResponse |
| 204 | No Data found | NoContentResponse |
| 400 | Bad Request Response | BadRequestError |
Job Category
These API's allows you to fetch the Job Categories.
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/activities/v1/category
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'
-H 'x-ph-userid: string'GET /jobs-api/activities/v1/category
Fetches All the available Job Categories.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
| x-ph-userid | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| locale | query | string | false |
| from | query | integer | false |
| limit | query | integer | false |
| keyword | query | string | false |
Response
200 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the operation to fetch job categories."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the fetch operation."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the fetch operation for job categories occurred."
},
"pagination": {
"type": "object",
"properties": {
"size": {
"type": "number",
"description": "The number of job categories in the current response."
},
"from": {
"type": "number",
"description": "The index from which the job categories are being retrieved."
},
"totalCount": {
"type": "number",
"description": "The total number of job categories available."
}
},
"description": "Pagination details for the list of job categories."
},
"data": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "The name of a job category."
}
},
"description": "Details of an individual job category within the array."
}
}
}
},
"description": "Response object for a successful fetch of job categories."
}
]204 response
copied![
{
"type": "object",
"description": "Response indicating no data has been found.",
"properties": {}
}
]400 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating a bad request."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "The timestamp when the error occurred."
},
"errorAPI": {
"type": "string",
"description": "The specific API on which the error has occurred."
},
"message": {
"type": "string",
"description": "A human readable error message describing the issue."
}
}
}
}
},
"description": "Response object for a bad request, containing details about errors."
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | GetJobCategories |
| 204 | 204 response | NoContentResponse |
| 400 | 400 response | BadRequestError |
Job Notes
These API's allows you to operate on notes related to Jobs.
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/activities/v1/jobs/{jobId}/notes
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'
-H 'x-ph-userid: string'GET /jobs-api/activities/v1/jobs/{jobId}/notes
Fetches Job Notes for the mentioned JobId.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
| x-ph-userid | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | path | string | true |
| from | query | integer | false |
| size | query | integer | false |
| recruiterEmail | query | string | false |
| includePrivateNotes | query | string | false |
Response
200 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the operation to fetch job notes."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the fetch operation."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the fetch operation for job notes occurred."
},
"pagination": {
"type": "object",
"properties": {
"size": {
"type": "number",
"description": "The number of notes in the current response."
},
"from": {
"type": "number",
"description": "The index from which the notes are being retrieved."
},
"totalCount": {
"type": "number",
"description": "The total number of notes available for the job."
}
},
"description": "Pagination details for the list of notes."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"updatedDate": {
"type": "string",
"description": "The date when the note was last updated."
},
"jobId": {
"type": "string",
"description": "The identifier for the job associated with the note."
},
"createdDate": {
"type": "string",
"description": "The date when the note was created."
},
"taggedRecruiters": {
"type": "array",
"items": {},
"description": "An array containing details of recruiters tagged to the note."
},
"name": {
"type": "string",
"description": "The name associated with the note."
},
"notes": {
"type": "string",
"description": "The content of the note."
}
}
},
"description": "An array containing details of job notes."
}
},
"description": "Response object for a successful fetch of job notes."
}
]204 response
copied![
{
"type": "object",
"description": "Response indicating no data has been found.",
"properties": {}
}
]400 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating a bad request."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "The timestamp when the error occurred."
},
"errorAPI": {
"type": "string",
"description": "The specific API on which the error has occurred."
},
"message": {
"type": "string",
"description": "A human readable error message describing the issue."
}
}
}
}
},
"description": "Response object for a bad request, containing details about errors."
}
]404 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating that the requested resource was not found."
},
"message": {
"type": "string",
"description": "A human readable message providing details about the not found error."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the not found error occurred."
}
},
"required": {
"0": "status",
"1": "message",
"2": "timestamp"
},
"description": "Response object for an error when the requested resource is not found."
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | GetJobNotesResponse |
| 204 | 204 response | NoContentResponse |
| 400 | 400 response | BadRequestError |
| 404 | 404 response | NotFoundError |
post
copied!# You can also use wgetcurl -X POST https://api-qa.phenompro.com/jobs-api/activities/v1/jobs/{jobId}/notes
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'
-H 'x-ph-userid: string'POST /jobs-api/activities/v1/jobs/{jobId}/notes
Creates Job Notes for the mentioned Job.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
| x-ph-userid | header | string | true |
Body Parameter
copied![
{
"type": "object",
"properties": {
"taggedRecruiters": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of recruiter IDs to be tagged to the job note."
},
"entityType": {
"type": "string",
"description": "The type of entity associated with the job note."
},
"noteText": {
"type": "string",
"description": "The text content of the job note."
},
"asPrivate": {
"type": "boolean",
"description": "A boolean indicating whether the job note should be marked as private, which restricts the visibility of the note to the user who created it."
}
},
"description": "Request object for creating job notes."
}
]Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | path | string | true |
Request Parameters
| Type | Name |
|---|---|
| application/json | CreateJobNoteRequest |
Response
200 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the operation to create job notes."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the creation of job notes."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the creation of job notes occurred."
}
},
"description": "Response object for a successful creation of job notes."
}
]204 response
copied![
{
"type": "object",
"description": "Response indicating no data has been found.",
"properties": {}
}
]400 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating a bad request."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "The timestamp when the error occurred."
},
"errorAPI": {
"type": "string",
"description": "The specific API on which the error has occurred."
},
"message": {
"type": "string",
"description": "A human readable error message describing the issue."
}
}
}
}
},
"description": "Response object for a bad request, containing details about errors."
}
]404 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating that the requested resource was not found."
},
"message": {
"type": "string",
"description": "A human readable message providing details about the not found error."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the not found error occurred."
}
},
"required": {
"0": "status",
"1": "message",
"2": "timestamp"
},
"description": "Response object for an error when the requested resource is not found."
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | CreateJobNoteResponse |
| 204 | 204 response | NoContentResponse |
| 400 | 400 response | BadRequestError |
| 404 | 404 response | NotFoundError |
Search
These APIs helps to find relevant job listings matching specific keywords.
post
copied!# You can also use wgetcurl -X POST https://api-qa.phenompro.com/jobs-api/v1/jobs/search/
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'POST /jobs-api/v1/jobs/search/
This API assist in discovering job listings that align with particular keywords or search terms.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Body Parameter
copied![
{
"type": "object",
"description": "Request to Search Jobs.",
"properties": {
"keywords": {
"type": "string",
"description": "Keyword to search."
},
"from": {
"type": "integer",
"description": "Starting point from which the data should be retrieved."
},
"size": {
"type": "integer",
"description": "Size of the response."
},
"booleanOperator": {
"type": "string",
"description": "Search operator accepts \"and\" / \"or\"."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"userType": {
"type": "string",
"description": "Type of the user - Internal or External User."
},
"orderBy": {
"type": "string",
"description": "Resultant order of jobs."
},
"facets": {
"type": "object",
"description": "Attributes and it's corresponding values to filter jobs.",
"properties": {
"city": {
"type": "array",
"items": {
"type": "string"
},
"description": "City filter will be applied based on the values present in the list."
},
"state": {
"type": "array",
"items": {
"type": "string"
},
"description": "State filter will be applied based on the values present in the list."
},
"country": {
"type": "array",
"items": {
"type": "string"
},
"description": "Country filter will be applied based on the values present in the list."
},
"category": {
"type": "array",
"items": {
"type": "string"
},
"description": "Category filter will be applied based on the values present in the list."
}
}
},
"ip": {
"type": "string",
"description": "User IP Address."
},
"locationData": {
"LocationData": {
"type": "object",
"properties": {
"latlong": {
"type": "string",
"description": "Latitude, Longitude of the location."
},
"location": {
"type": "string",
"description": "Location Value."
},
"radius": {
"type": "integer",
"description": "Radius to consider from the entered location."
},
"radiusUnit": {
"type": "string",
"description": "Radius unit to consider."
}
}
}
}
}
}
]Request Parameters
| Type | Name |
|---|---|
| application/json | JobSearchRequest |
Response
Returns filtered jobs.
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status returned by the API."
},
"data": {
"type": "object",
"description": "Job Search Response data.",
"properties": {
"jobs": {
"type": "array",
"items": {
"JobNode": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the Job."
},
"jobId": {
"type": "string",
"description": "Job ID - unique field to identify the job."
},
"city": {
"type": "string",
"description": "City value where the job is posted."
},
"state": {
"type": "string",
"description": "State value where the job is posted."
},
"country": {
"type": "string",
"description": "Country value where the job is posted."
},
"location": {
"type": "string",
"description": "Location of the job posted."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"jobUpdatedDate": {
"type": "string",
"description": "Timestamp where the latest update was pushed to the job."
},
"createdDate": {
"type": "string",
"description": "Timestamp when the job was created."
},
"category": {
"type": "string",
"description": "Job Category."
},
"multiCategory": {
"type": "array",
"description": "List of categories where the job is posted to.",
"items": {
"type": "string",
"description": "category where the job is posted to."
}
},
"multiLocation": {
"type": "array",
"description": "List of locations where the job is posted.",
"items": {
"type": "string",
"description": "locations where the job is posted."
}
}
}
}
}
}
}
}
}
}
]Bad Request.
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Server Error.
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Returns filtered jobs. | JobSearchResponse |
| 400 | Bad Request. | BadRequest |
| 500 | Server Error. | ErrorResponse |
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/v1/jobs/search/suggestions
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'GET /jobs-api/v1/jobs/search/suggestions
This API offers automatic suggestions for job titles based on entered keywords or search terms.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| searchBy | query | string | true |
| limit | query | string | false |
| prefix | query | string | true |
Response
Typeahead results filtered based on input prefix.
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status returned by the API."
},
"data": {
"type": "object",
"description": "Response.",
"properties": {
"titles": {
"type": "array",
"description": "List of Titles.",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the job."
},
"jobId": {
"type": "string",
"description": "Job ID - Unique Identifier of the job."
},
"titleHtml": {
"type": "string",
"description": "Title of the job with highlighted tags."
}
}
}
}
}
}
}
}
]Bad Request.
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Server Error.
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Typeahead results filtered based on input prefix. | JobTitlesResponse |
| 400 | Bad Request. | BadRequest |
| 500 | Server Error. | ErrorResponse |
Recommendations
These APIs provide job suggestions based on your profile, akin job listings, and nearby job opportunities tailored to your qualifications.
post
copied!# You can also use wgetcurl -X POST https://api-qa.phenompro.com/jobs-api/v1/jobs/recommendation/profile-matched
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'POST /jobs-api/v1/jobs/recommendation/profile-matched
This API provides job recommendations for a profile.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Body Parameter
copied![
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"default": "external",
"description": "Persona Value - Example: Internal, External."
},
"userType": {
"type": "string",
"default": "external",
"description": "Type of the user - Internal or External User."
},
"userId": {
"type": "string",
"description": "Unique identified for a user."
},
"userProfile": {
"UserProfile": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string",
"description": "List of categories from which the recommendations should be provided."
}
},
"skills": {
"type": "array",
"items": {
"type": "string",
"description": "Skill set of the user."
}
},
"title": {
"type": "string",
"description": "Recent designation of the user."
},
"yearsOfExperience": {
"type": "string",
"example": "0-5",
"description": "Total number of years of experience of the user."
},
"preferredLocations": {
"type": "array",
"items": {
"PreferredLocations": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Preferred location of the user."
},
"latlong": {
"type": "object",
"properties": {
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of the preferred location provided by user."
},
"lan": {
"type": "number",
"format": "double",
"description": "Latitude of the preferred location provided by user."
}
}
}
}
}
}
}
}
}
},
"maxRecommendationSize": {
"type": "integer",
"description": "Maximum recommendations to be provided in response."
}
}
}
]Request Parameters
| Type | Name |
|---|---|
| application/json | JobRecommendation |
Response
200 response
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"default": "200",
"description": "HTTP Status code determining the response status."
},
"totalCount": {
"type": "integer",
"description": "Total recommendations identified by the service."
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the recommended job."
},
"category": {
"type": "string",
"description": "Category to which the recommended job belongs to."
},
"jobId": {
"type": "string",
"description": "Unique identifier for a job."
},
"city": {
"type": "string",
"description": "Primary city of the job's location."
},
"state": {
"type": "string",
"description": "Primary state of the job's location."
},
"country": {
"type": "string",
"description": "Primary country of the job's location."
},
"applyUrl": {
"type": "string",
"description": "Apply url for the job."
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Server Error
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | ProfileMatchingResponse |
| 400 | Bad Request | BadRequest |
| 500 | Server Error | ErrorResponse |
post
copied!# You can also use wgetcurl -X POST https://api-qa.phenompro.com/jobs-api/v1/jobs/recommendation/similarjobs
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'POST /jobs-api/v1/jobs/recommendation/similarjobs
This API provides similar jobs to the given job.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Body Parameter
copied![
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"userType": {
"type": "string",
"description": "Type of the user - Internal or External User."
},
"size": {
"type": "integer",
"description": "Size of the response."
}
}
}
]Parameters
| Name | In | Type | Required |
|---|---|---|---|
| jobId | query | string | true |
Request Parameters
| Type | Name |
|---|---|
| application/json | SimilarJobsRequest |
Response
found the api
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "HTTP Status code determining the response status."
},
"hits": {
"type": "integer",
"description": "No of hits."
},
"data": {
"type": "object",
"properties": {
"similarJobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the recommended job."
},
"jobId": {
"type": "string",
"description": "Job ID - unique field to identify the job."
},
"category": {
"type": "string",
"description": "Category to which the job belongs to."
},
"city": {
"type": "string",
"description": "City of the Location to which the job belongs to."
},
"state": {
"type": "string",
"description": "State of the Location to which the job belongs to."
},
"country": {
"type": "string",
"description": "Country of the Location to which the job belongs to."
},
"applyUrl": {
"type": "string",
"description": "Apply Url of the job."
}
}
}
}
}
}
}
}
]Some exception occured while extracting features.
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | found the api | SimilarJobsResponse |
| 400 | Some exception occured while extracting features. | ErrorResponse |
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/jobs-api/v1/jobs/recommendation/nearby
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'GET /jobs-api/v1/jobs/recommendation/nearby
This API provides job listings nearby, using location as a parameter for the search.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| latitude | query | number | true |
| longitude | query | number | true |
| radius | query | integer |
Response
Returns Locations matching with given keyword.
copied![
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "HTTP Status code determining the response status."
},
"data": {
"type": "object",
"description": "Near By Jobs Response data.",
"properties": {
"nearbyjobs": {
"type": "array",
"items": {
"JobNode": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the Job."
},
"jobId": {
"type": "string",
"description": "Job ID - unique field to identify the job."
},
"city": {
"type": "string",
"description": "City value where the job is posted."
},
"state": {
"type": "string",
"description": "State value where the job is posted."
},
"country": {
"type": "string",
"description": "Country value where the job is posted."
},
"location": {
"type": "string",
"description": "Location of the job posted."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"jobUpdatedDate": {
"type": "string",
"description": "Timestamp where the latest update was pushed to the job."
},
"createdDate": {
"type": "string",
"description": "Timestamp when the job was created."
},
"category": {
"type": "string",
"description": "Job Category."
},
"multiCategory": {
"type": "array",
"description": "List of categories where the job is posted to.",
"items": {
"type": "string",
"description": "category where the job is posted to."
}
},
"multiLocation": {
"type": "array",
"description": "List of locations where the job is posted.",
"items": {
"type": "string",
"description": "locations where the job is posted."
}
}
}
}
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Server Error
copied![
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Returns Locations matching with given keyword. | NearByJobsResponse |
| 400 | Bad Request | BadRequest |
| 500 | Server Error | ErrorResponse |
Schemas
copied!{
"type": "object",
"properties": {
"opType": {
"type": "string",
"description": "The operation type for updating the hiring team."
},
"hiringTeamList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of a member in the hiring team."
},
"emailId": {
"type": "string",
"description": "The email address of a member in the hiring team."
},
"role": {
"type": "string",
"description": "The role of a member in the hiring team."
}
},
"required": [
"name",
"emailId",
"role"
],
"description": "Details of a member in the hiring team."
},
"description": "An array containing details of members in the hiring team for the update."
}
},
"required": [
"opType",
"hiringTeamList"
],
"description": "Request object for updating the hiring team of jobs."
}Properties
| Name | Type | Description |
|---|---|---|
| opType | string | The operation type for updating the hiring team. |
| hiringTeamList | [object] | An array containing details of members in the hiring team for the update. |
| name | string | The name of a member in the hiring team. |
| emailId | string | The email address of a member in the hiring team. |
| role | string | The role of a member in the hiring team. |
copied!{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hiringTeamList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"description": "Role or position of a member in the hiring team."
},
"createdDate": {
"type": "number",
"description": "Timestamp indicating when the member was created in the hiring team."
},
"read": {
"type": "string",
"description": "Read status or permission of the member."
},
"name": {
"type": "string",
"description": "Name of the member in the hiring team."
},
"emailId": {
"type": "string",
"description": "Email address of the member in the hiring team."
},
"source": {
"type": "string",
"description": "Source or origin of the member in the hiring team."
}
},
"required": [
"role",
"createdDate",
"read",
"name",
"emailId",
"source"
]
}
}
},
"required": [
"hiringTeamList"
]
},
"description": "Array of objects containing information about the hiring team members."
},
"message": {
"type": "string",
"description": "A human readable message providing details about the operation result."
},
"status": {
"type": "string",
"description": "Indicates the status of the operation (e.g., success, failure)."
},
"timestamp": {
"type": "string",
"description": "Timestamp indicating when the operation was performed."
}
},
"required": [
"data",
"message",
"status",
"timestamp"
]
}Properties
| Name | Type | Description |
|---|---|---|
| data | [object] | Array of objects containing information about the hiring team members. |
| hiringTeamList | [object] | |
| role | string | Role or position of a member in the hiring team. |
| createdDate | number | Timestamp indicating when the member was created in the hiring team. |
| read | string | Read status or permission of the member. |
| name | string | Name of the member in the hiring team. |
| emailId | string | Email address of the member in the hiring team. |
| source | string | Source or origin of the member in the hiring team. |
| message | string | A human readable message providing details about the operation result. |
| status | string | Indicates the status of the operation (e.g., success, failure). |
| timestamp | string | Timestamp indicating when the operation was performed. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the update operation on the hiring team."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the update operation."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the update operation on the hiring team occurred."
}
},
"description": "Response object for a successful update of the hiring team."
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | The status indicating the success of the update operation on the hiring team. |
| message | string | A human readable message providing additional information about the update operation. |
| timestamp | string | The timestamp indicating when the update operation on the hiring team occurred. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating that the requested resource was not found."
},
"message": {
"type": "string",
"description": "A human readable message providing details about the not found error."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the not found error occurred."
}
},
"required": [
"status",
"message",
"timestamp"
],
"description": "Response object for an error when the requested resource is not found."
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | The status indicating that the requested resource was not found. |
| message | string | A human readable message providing details about the not found error. |
| timestamp | string | The timestamp indicating when the not found error occurred. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating an internal server error."
},
"message": {
"type": "string",
"description": "A human readable message providing details about the internal server error."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the internal server error occurred."
}
},
"required": [
"status",
"message",
"timestamp"
],
"description": "Response object for an internal server error."
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | The status indicating an internal server error. |
| message | string | A human readable message providing details about the internal server error. |
| timestamp | string | The timestamp indicating when the internal server error occurred. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the operation to fetch job attachments."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the fetch operation."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the fetch operation for job attachments occurred."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachmentDate": {
"type": "string",
"description": "The date when the attachment was added to the job."
},
"createdByUserName": {
"type": "string",
"description": "The name of the user who added the attachment to the job."
},
"attachmentName": {
"type": "string",
"description": "The name of the attachment."
},
"attachmentId": {
"type": "string",
"description": "The unique identifier for the attachment."
},
"createdByUserEmail": {
"type": "string",
"description": "The email address of the user who added the attachment to the job."
}
}
},
"description": "An array containing details of job attachments."
}
},
"description": "Response object for a successful fetch of job attachments."
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | The status indicating the success of the operation to fetch job attachments. |
| message | string | A human readable message providing additional information about the fetch operation. |
| timestamp | string | The timestamp indicating when the fetch operation for job attachments occurred. |
| data | [object] | An array containing details of job attachments. |
| attachmentDate | string | The date when the attachment was added to the job. |
| createdByUserName | string | The name of the user who added the attachment to the job. |
| attachmentName | string | The name of the attachment. |
| attachmentId | string | The unique identifier for the attachment. |
| createdByUserEmail | string | The email address of the user who added the attachment to the job. |
copied!{
"type": "object",
"description": "Response indicating no data has been found.",
"properties": {}
}Properties
| Name | Type |
|---|
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the operation to fetch job notes."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the fetch operation."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the fetch operation for job notes occurred."
},
"pagination": {
"type": "object",
"properties": {
"size": {
"type": "number",
"description": "The number of notes in the current response."
},
"from": {
"type": "number",
"description": "The index from which the notes are being retrieved."
},
"totalCount": {
"type": "number",
"description": "The total number of notes available for the job."
}
},
"description": "Pagination details for the list of notes."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"updatedDate": {
"type": "string",
"description": "The date when the note was last updated."
},
"jobId": {
"type": "string",
"description": "The identifier for the job associated with the note."
},
"createdDate": {
"type": "string",
"description": "The date when the note was created."
},
"taggedRecruiters": {
"type": "array",
"items": {},
"description": "An array containing details of recruiters tagged to the note."
},
"name": {
"type": "string",
"description": "The name associated with the note."
},
"notes": {
"type": "string",
"description": "The content of the note."
}
}
},
"description": "An array containing details of job notes."
}
},
"description": "Response object for a successful fetch of job notes."
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | The status indicating the success of the operation to fetch job notes. |
| message | string | A human readable message providing additional information about the fetch operation. |
| timestamp | string | The timestamp indicating when the fetch operation for job notes occurred. |
| pagination | object | Pagination details for the list of notes. |
| size | number | The number of notes in the current response. |
| from | number | The index from which the notes are being retrieved. |
| totalCount | number | The total number of notes available for the job. |
| data | [object] | An array containing details of job notes. |
| updatedDate | string | The date when the note was last updated. |
| jobId | string | The identifier for the job associated with the note. |
| createdDate | string | The date when the note was created. |
| taggedRecruiters | array | An array containing details of recruiters tagged to the note. |
| name | string | The name associated with the note. |
| notes | string | The content of the note. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating a bad request."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "The timestamp when the error occurred."
},
"errorAPI": {
"type": "string",
"description": "The specific API on which the error has occurred."
},
"message": {
"type": "string",
"description": "A human readable error message describing the issue."
}
}
}
}
},
"description": "Response object for a bad request, containing details about errors."
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | The status indicating a bad request. |
| errors | [object] | |
| timestamp | string | The timestamp when the error occurred. |
| errorAPI | string | The specific API on which the error has occurred. |
| message | string | A human readable error message describing the issue. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the operation to fetch job categories."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the fetch operation."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the fetch operation for job categories occurred."
},
"pagination": {
"type": "object",
"properties": {
"size": {
"type": "number",
"description": "The number of job categories in the current response."
},
"from": {
"type": "number",
"description": "The index from which the job categories are being retrieved."
},
"totalCount": {
"type": "number",
"description": "The total number of job categories available."
}
},
"description": "Pagination details for the list of job categories."
},
"data": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "The name of a job category."
}
},
"description": "Details of an individual job category within the array."
}
}
}
},
"description": "Response object for a successful fetch of job categories."
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | The status indicating the success of the operation to fetch job categories. |
| message | string | A human readable message providing additional information about the fetch operation. |
| timestamp | string | The timestamp indicating when the fetch operation for job categories occurred. |
| pagination | object | Pagination details for the list of job categories. |
| size | number | The number of job categories in the current response. |
| from | number | The index from which the job categories are being retrieved. |
| totalCount | number | The total number of job categories available. |
| data | array | |
| category | string | The name of a job category. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status indicating the success of the operation to create job notes."
},
"message": {
"type": "string",
"description": "A human readable message providing additional information about the creation of job notes."
},
"timestamp": {
"type": "string",
"description": "The timestamp indicating when the creation of job notes occurred."
}
},
"description": "Response object for a successful creation of job notes."
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | The status indicating the success of the operation to create job notes. |
| message | string | A human readable message providing additional information about the creation of job notes. |
| timestamp | string | The timestamp indicating when the creation of job notes occurred. |
copied!{
"type": "object",
"properties": {
"taggedRecruiters": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of recruiter IDs to be tagged to the job note."
},
"entityType": {
"type": "string",
"description": "The type of entity associated with the job note."
},
"noteText": {
"type": "string",
"description": "The text content of the job note."
},
"asPrivate": {
"type": "boolean",
"description": "A boolean indicating whether the job note should be marked as private, which restricts the visibility of the note to the user who created it."
}
},
"description": "Request object for creating job notes."
}Properties
| Name | Type | Description |
|---|---|---|
| taggedRecruiters | [string] | An array of recruiter IDs to be tagged to the job note. |
| entityType | string | The type of entity associated with the job note. |
| noteText | string | The text content of the job note. |
| asPrivate | boolean | A boolean indicating whether the job note should be marked as private, which restricts the visibility of the note to the user who created it. |
copied!{
"title": "EmptySchema",
"type": "object"
}Properties
| Name | Type |
|---|
copied!{
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| category | string | Phenom job category. |
copied!{
"required": [
"description",
"jobId",
"reqId",
"title"
],
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": [
"recruiterEmail",
"recruiterName"
],
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": [
"hiringManagerEmail",
"hiringManagerName"
],
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| applyUrl | string | Apply url of the job. |
| category | string | Phenom job category. |
| companyName | string | Tenant name. |
| description | string | ATS job description. |
| externalApply | boolean | To have Apply Button for job |
| jobId | string | ATS jobId. |
| locale | string | Locale of the site (Language_Country). |
| reqId | string | ATS requisition id. |
| siteType | string | Persona that the job belongs to. |
| title | string | ATS job title. |
| employmentType | string | Type that the job belongs to. |
| city | string | ATS job posting city name. |
| state | string | ATS job posting state name. |
| country | string | ATS job posting country name. |
| address | string | ATS job posting address. |
| postalCode | string | ATS job posting location zip code. |
| hiringManagerEmail | string | Email of hiring manager associated to the job. |
| hiringManagerName | string | Name of hiring manager associated to the job. |
| recruiterEmail | string | Email of the recruiter assigned to the job. |
| recruiterName | string | Name of the recruiter assigned to the job. |
| source | string | Job source. |
| displayCareerSite | boolean | To display the job on career site or not. |
| multiLocation | array | LocationDTO |
| multiCategory | array | Category |
| multiRecruiter | array | Recruiter |
| multiHiringManager | array | HiringManager |
| additionalFields | object | Additional fields associated to the job. |
| visibilityLocale | [string] | All locales that the job belongs to. |
| visibilitySiteType | [string] | All personas that the jobs belongs to. |
| isPrivateJob | boolean | This will be true if the job is private and not visible to the public. |
| isConfidentialJob | boolean | This will be true if the job is confidential and not visible to the public. |
| postedDate | string | Date when the job was posted. |
copied!{
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": [
"recruiterEmail",
"recruiterName"
],
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": [
"hiringManagerEmail",
"hiringManagerName"
],
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| applyUrl | string | Apply url of the job. |
| ats | string | Ats of the job. |
| category | string | Phenom job category. |
| externalApply | boolean | To have Apply Button for job |
| companyName | string | Tenant name. |
| description | string | ATS job description. |
| jobId | string | ATS jobId. |
| locale | string | Locale of the site (Language_Country). |
| reqId | string | ATS requisition id. |
| siteType | string | Persona that the job belongs to. |
| title | string | ATS job title. |
| employmentType | string | Type that the job belongs to. |
| city | string | ATS job posting city name. |
| state | string | ATS job posting state name. |
| country | string | ATS job posting country name. |
| address | string | ATS job posting address. |
| postalCode | string | ATS job posting location zip code. |
| hiringManagerEmail | string | Email of hiring manager associated to the job. |
| hiringManagerName | string | Name of hiring manager associated to the job. |
| recruiterEmail | string | Email of the recruiter assigned to the job. |
| recruiterName | string | Name of the recruiter assigned to the job. |
| source | string | Job source. |
| displayCareerSite | boolean | To display the job on career site or not. |
| multiLocation | array | LocationDTO |
| multiCategory | array | Category |
| multiRecruiter | array | Recruiter |
| multiHiringManager | array | HiringManager |
| additionalFields | object | Additional fields associated to the job. |
| referenceId | string | Reference Id of the Job |
| visibilityLocale | [string] | All locales that the job belongs to. |
| visibilitySiteType | [string] | All personas that the jobs belongs to. |
| isPrivateJob | boolean | This will be true if the job is private and not visible to the public. |
| isConfidentialJob | boolean | This will be true if the job is confidential and not visible to the public. |
| postedDate | string | Date when the job was posted. |
| createdDate | string | Date when the job was created in phenom. |
| updatedDate | string | Date when the job was updated. |
| descriptionTeaser | string | Description teaser of the job. |
copied!{
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| cityState | string | City State of Job |
| cityCountry | string | City Country of Job |
| cityStateCountry | string | City State Country of Job |
| stateCountry | string | State Country of Job |
| locationDisplay | string | Display Location of Job |
| city | string | ATS job posting city name. |
| state | string | ATS job posting state name. |
| country | string | ATS job posting country name. |
| address | string | ATS job posting address. |
| postalCode | string | ATS job posting location zip code. |
copied!{
"type": "object",
"properties": {
"job": {
"JobRequestDTO": {
"required": [
"description",
"jobId",
"reqId",
"title"
],
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": [
"recruiterEmail",
"recruiterName"
],
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": [
"hiringManagerEmail",
"hiringManagerName"
],
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
}
}
}
},
"postings": {
"type": "array",
"items": {
"PostingDTO": {
"type": "object",
"required": [
"locale",
"siteType"
],
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"siteType": {
"type": "string",
"description": "SiteType of the job."
},
"category": {
"type": "string",
"description": "Category of the job."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"description": {
"type": "string",
"description": "Description of the job."
},
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| job | object | JobRequestDTO |
| postings | array | PostingDTO |
copied!{
"type": "object",
"required": [
"locale",
"siteType"
],
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"siteType": {
"type": "string",
"description": "SiteType of the job."
},
"category": {
"type": "string",
"description": "Category of the job."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"description": {
"type": "string",
"description": "Description of the job."
},
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Locale of the site (Language_Country). |
| siteType | string | SiteType of the job. |
| category | string | Category of the job. |
| title | string | ATS job title. |
| description | string | Description of the job. |
| applyUrl | string | Apply url of the job. |
| visibilityLocale | [string] | All locales that the job belongs to. |
| visibilitySiteType | [string] | All personas that the jobs belongs to. |
| additionalFields | object | Additional fields associated to the job. |
| isPrivateJob | boolean | This will be true if the job is private and not visible to the public. |
| isConfidentialJob | boolean | This will be true if the job is confidential and not visible to the public. |
| postedDate | string | Date when the job was posted. |
copied!{
"required": [
"recruiterEmail",
"recruiterName"
],
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| recruiterName | string | Name of the recruiter assigned to the job. |
| recruiterEmail | string | Email of the recruiter assigned to the job. |
copied!{
"required": [
"hiringManagerEmail",
"hiringManagerName"
],
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| hiringManagerName | string | Name of the hiring manager. |
| hiringManagerEmail | string | Email of the hiring manager. |
| role | string | Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the response."
},
"message": {
"type": "string",
"description": "Response message."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": [
"recruiterEmail",
"recruiterName"
],
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": [
"hiringManagerEmail",
"hiringManagerName"
],
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | Status code of the response. |
| message | string | Response message. |
| data | array | JobResponseDTO |
copied!{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the response."
},
"message": {
"type": "string",
"description": "Response message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | Status code of the response. |
| message | string | Response message. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"offset": {
"type": "integer",
"description": "Parameter defines from which point to query for jobs."
},
"limit": {
"type": "integer",
"description": "Parameter defines how many jobs to query."
},
"totalRecordsCount": {
"type": "integer",
"description": "Total number of jobs for given query."
},
"data": {
"type": "array",
"description": "List of jobs.",
"items": {
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": [
"recruiterEmail",
"recruiterName"
],
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": [
"hiringManagerEmail",
"hiringManagerName"
],
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | Status of the response. |
| offset | integer | Parameter defines from which point to query for jobs. |
| limit | integer | Parameter defines how many jobs to query. |
| totalRecordsCount | integer | Total number of jobs for given query. |
| data | array | JobResponseDTO |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the response."
},
"data": {
"type": "object",
"description": "Job.",
"JobResponseDTO": {
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"ats": {
"type": "string",
"description": "Ats of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"description": {
"type": "string",
"description": "ATS job description."
},
"jobId": {
"type": "string",
"description": "ATS jobId."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country)."
},
"reqId": {
"type": "string",
"description": "ATS requisition id."
},
"siteType": {
"type": "string",
"description": "Persona that the job belongs to."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": [
"recruiterEmail",
"recruiterName"
],
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": [
"hiringManagerEmail",
"hiringManagerName"
],
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"referenceId": {
"type": "string",
"description": "Reference Id of the Job"
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
},
"createdDate": {
"type": "string",
"description": "Date when the job was created in phenom."
},
"updatedDate": {
"type": "string",
"description": "Date when the job was updated."
},
"descriptionTeaser": {
"type": "string",
"description": "Description teaser of the job."
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | Status of the response. |
| data | object | JobResponseDTO |
copied!{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | Status returned by the API. |
| message | string | Error Message. |
copied!{
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "Error Code."
},
"errorDesc": {
"type": "string",
"description": "Error Description."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| errorCode | string | Error Code. |
| errorDesc | string | Error Description. |
copied!{
"type": "object",
"properties": {
"applyUrl": {
"type": "string",
"description": "Apply url of the job."
},
"category": {
"type": "string",
"description": "Phenom job category."
},
"companyName": {
"type": "string",
"description": "Tenant name."
},
"externalApply": {
"type": "boolean",
"description": "To have Apply Button for job"
},
"description": {
"type": "string",
"description": "ATS job description."
},
"title": {
"type": "string",
"description": "ATS job title."
},
"employmentType": {
"type": "string",
"description": "Type that the job belongs to."
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of hiring manager associated to the job."
},
"hiringManagerName": {
"type": "string",
"description": "Name of hiring manager associated to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
},
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"source": {
"type": "string",
"description": "Job source."
},
"displayCareerSite": {
"type": "boolean",
"description": "To display the job on career site or not."
},
"multiLocation": {
"type": "array",
"description": "All job posting locations, includes /excludes primary posting location.",
"items": {
"LocationDTO": {
"type": "object",
"properties": {
"cityState": {
"type": "string",
"description": "City State of Job"
},
"cityCountry": {
"type": "string",
"description": "City Country of Job"
},
"cityStateCountry": {
"type": "string",
"description": "City State Country of Job"
},
"stateCountry": {
"type": "string",
"description": "State Country of Job"
},
"locationDisplay": {
"type": "string",
"description": "Display Location of Job"
},
"city": {
"type": "string",
"description": "ATS job posting city name."
},
"state": {
"type": "string",
"description": "ATS job posting state name."
},
"country": {
"type": "string",
"description": "ATS job posting country name."
},
"address": {
"type": "string",
"description": "ATS job posting address."
},
"postalCode": {
"type": "string",
"description": "ATS job posting location zip code."
}
}
}
}
},
"multiCategory": {
"type": "array",
"description": "All categories that the job belongs to.",
"items": {
"Category": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Phenom job category."
}
}
}
}
},
"multiRecruiter": {
"type": "array",
"description": "Data of recruiters assigned to the job(array).",
"items": {
"Recruiter": {
"required": [
"recruiterEmail",
"recruiterName"
],
"type": "object",
"properties": {
"recruiterName": {
"type": "string",
"description": "Name of the recruiter assigned to the job."
},
"recruiterEmail": {
"type": "string",
"description": "Email of the recruiter assigned to the job."
}
}
}
}
},
"multiHiringManager": {
"type": "array",
"description": "Additional hiring managers beyond the primary hiringManagerName/hiringManagerEmail, each with optional role.",
"items": {
"HiringManager": {
"required": [
"hiringManagerEmail",
"hiringManagerName"
],
"type": "object",
"properties": {
"hiringManagerName": {
"type": "string",
"description": "Name of the hiring manager."
},
"hiringManagerEmail": {
"type": "string",
"description": "Email of the hiring manager."
},
"role": {
"type": "string",
"description": "Optional. When omitted or blank, the service defaults to Hiring Manager. When present, must be one of: Interviewer, Hiring Manager, Recruiter, Sourcer."
}
}
}
}
},
"additionalFields": {
"type": "object",
"description": "Additional fields associated to the job."
},
"visibilityLocale": {
"type": "array",
"description": "All locales that the job belongs to.",
"items": {
"type": "string"
}
},
"visibilitySiteType": {
"type": "array",
"description": "All personas that the jobs belongs to.",
"items": {
"type": "string"
}
},
"isPrivateJob": {
"type": "boolean",
"description": "This will be true if the job is private and not visible to the public."
},
"isConfidentialJob": {
"type": "boolean",
"description": "This will be true if the job is confidential and not visible to the public."
},
"postedDate": {
"type": "string",
"description": "Date when the job was posted."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| applyUrl | string | Apply url of the job. |
| category | string | Phenom job category. |
| companyName | string | Tenant name. |
| externalApply | boolean | To have Apply Button for job |
| description | string | ATS job description. |
| title | string | ATS job title. |
| employmentType | string | Type that the job belongs to. |
| city | string | ATS job posting city name. |
| state | string | ATS job posting state name. |
| country | string | ATS job posting country name. |
| address | string | ATS job posting address. |
| postalCode | string | ATS job posting location zip code. |
| hiringManagerEmail | string | Email of hiring manager associated to the job. |
| hiringManagerName | string | Name of hiring manager associated to the job. |
| recruiterEmail | string | Email of the recruiter assigned to the job. |
| recruiterName | string | Name of the recruiter assigned to the job. |
| source | string | Job source. |
| displayCareerSite | boolean | To display the job on career site or not. |
| multiLocation | array | LocationDTO |
| multiCategory | array | Category |
| multiRecruiter | array | Recruiter |
| multiHiringManager | array | HiringManager |
| additionalFields | object | Additional fields associated to the job. |
| visibilityLocale | [string] | All locales that the job belongs to. |
| visibilitySiteType | [string] | All personas that the jobs belongs to. |
| isPrivateJob | boolean | This will be true if the job is private and not visible to the public. |
| isConfidentialJob | boolean | This will be true if the job is confidential and not visible to the public. |
| postedDate | string | Date when the job was posted. |
copied!{
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Preferred location of the user."
},
"latlong": {
"type": "object",
"properties": {
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of the preferred location provided by user."
},
"lan": {
"type": "number",
"format": "double",
"description": "Latitude of the preferred location provided by user."
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| location | string | Preferred location of the user. |
| latlong | object | |
| lon | number | Longitude of the preferred location provided by user. |
| lan | number | Latitude of the preferred location provided by user. |
copied!{
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"default": "external",
"description": "Persona Value - Example: Internal, External."
},
"userType": {
"type": "string",
"default": "external",
"description": "Type of the user - Internal or External User."
},
"userId": {
"type": "string",
"description": "Unique identified for a user."
},
"userProfile": {
"UserProfile": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string",
"description": "List of categories from which the recommendations should be provided."
}
},
"skills": {
"type": "array",
"items": {
"type": "string",
"description": "Skill set of the user."
}
},
"title": {
"type": "string",
"description": "Recent designation of the user."
},
"yearsOfExperience": {
"type": "string",
"example": "0-5",
"description": "Total number of years of experience of the user."
},
"preferredLocations": {
"type": "array",
"items": {
"PreferredLocations": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Preferred location of the user."
},
"latlong": {
"type": "object",
"properties": {
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of the preferred location provided by user."
},
"lan": {
"type": "number",
"format": "double",
"description": "Latitude of the preferred location provided by user."
}
}
}
}
}
}
}
}
}
},
"maxRecommendationSize": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"description": "Maximum recommendations to be provided in response."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Locale of the site (Language_Country) - Example: en_US. |
| siteType | string | Persona Value - Example: Internal, External. |
| userType | string | Type of the user - Internal or External User. |
| userId | string | Unique identified for a user. |
| userProfile | object | UserProfile |
| maxRecommendationSize | integer | Maximum recommendations to be provided in response. |
copied!{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string",
"description": "List of categories from which the recommendations should be provided."
}
},
"skills": {
"type": "array",
"items": {
"type": "string",
"description": "Skill set of the user."
}
},
"title": {
"type": "string",
"description": "Recent designation of the user."
},
"yearsOfExperience": {
"type": "string",
"example": "0-5",
"description": "Total number of years of experience of the user."
},
"preferredLocations": {
"type": "array",
"items": {
"PreferredLocations": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Preferred location of the user."
},
"latlong": {
"type": "object",
"properties": {
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of the preferred location provided by user."
},
"lan": {
"type": "number",
"format": "double",
"description": "Latitude of the preferred location provided by user."
}
}
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| categories | [string] | List of categories from which the recommendations should be provided. |
| skills | [string] | Skill set of the user. |
| title | string | Recent designation of the user. |
| yearsOfExperience | string | Total number of years of experience of the user. |
| preferredLocations | array | PreferredLocations |
copied!{
"type": "object",
"properties": {
"status": {
"type": "integer",
"default": "200",
"description": "HTTP Status code determining the response status."
},
"totalCount": {
"type": "integer",
"description": "Total recommendations identified by the service."
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the recommended job."
},
"category": {
"type": "string",
"description": "Category to which the recommended job belongs to."
},
"jobId": {
"type": "string",
"description": "Unique identifier for a job."
},
"city": {
"type": "string",
"description": "Primary city of the job's location."
},
"state": {
"type": "string",
"description": "Primary state of the job's location."
},
"country": {
"type": "string",
"description": "Primary country of the job's location."
},
"applyUrl": {
"type": "string",
"description": "Apply url for the job."
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | HTTP Status code determining the response status. |
| totalCount | integer | Total recommendations identified by the service. |
| jobs | [object] | |
| title | string | Title of the recommended job. |
| category | string | Category to which the recommended job belongs to. |
| jobId | string | Unique identifier for a job. |
| city | string | Primary city of the job's location. |
| state | string | Primary state of the job's location. |
| country | string | Primary country of the job's location. |
| applyUrl | string | Apply url for the job. |
copied!{
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"userType": {
"type": "string",
"description": "Type of the user - Internal or External User."
},
"size": {
"type": "integer",
"description": "Size of the response."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Locale of the site (Language_Country) - Example: en_US. |
| siteType | string | Persona Value - Example: Internal, External. |
| userType | string | Type of the user - Internal or External User. |
| size | integer | Size of the response. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "HTTP Status code determining the response status."
},
"hits": {
"type": "integer",
"description": "No of hits."
},
"data": {
"type": "object",
"properties": {
"similarJobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the recommended job."
},
"jobId": {
"type": "string",
"description": "Job ID - unique field to identify the job."
},
"category": {
"type": "string",
"description": "Category to which the job belongs to."
},
"city": {
"type": "string",
"description": "City of the Location to which the job belongs to."
},
"state": {
"type": "string",
"description": "State of the Location to which the job belongs to."
},
"country": {
"type": "string",
"description": "Country of the Location to which the job belongs to."
},
"applyUrl": {
"type": "string",
"description": "Apply Url of the job."
}
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | HTTP Status code determining the response status. |
| hits | integer | No of hits. |
| data | object | |
| similarJobs | [object] | |
| title | string | Title of the recommended job. |
| jobId | string | Job ID - unique field to identify the job. |
| category | string | Category to which the job belongs to. |
| city | string | City of the Location to which the job belongs to. |
| state | string | State of the Location to which the job belongs to. |
| country | string | Country of the Location to which the job belongs to. |
| applyUrl | string | Apply Url of the job. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "HTTP Status code determining the response status."
},
"data": {
"type": "object",
"description": "Near By Jobs Response data.",
"properties": {
"nearbyjobs": {
"type": "array",
"items": {
"JobNode": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the Job."
},
"jobId": {
"type": "string",
"description": "Job ID - unique field to identify the job."
},
"city": {
"type": "string",
"description": "City value where the job is posted."
},
"state": {
"type": "string",
"description": "State value where the job is posted."
},
"country": {
"type": "string",
"description": "Country value where the job is posted."
},
"location": {
"type": "string",
"description": "Location of the job posted."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"jobUpdatedDate": {
"type": "string",
"description": "Timestamp where the latest update was pushed to the job."
},
"createdDate": {
"type": "string",
"description": "Timestamp when the job was created."
},
"category": {
"type": "string",
"description": "Job Category."
},
"multiCategory": {
"type": "array",
"description": "List of categories where the job is posted to.",
"items": {
"type": "string",
"description": "category where the job is posted to."
}
},
"multiLocation": {
"type": "array",
"description": "List of locations where the job is posted.",
"items": {
"type": "string",
"description": "locations where the job is posted."
}
}
}
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | HTTP Status code determining the response status. |
| data | object | Near By Jobs Response data. |
| nearbyjobs | array | JobNode |
copied!{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the Job."
},
"jobId": {
"type": "string",
"description": "Job ID - unique field to identify the job."
},
"city": {
"type": "string",
"description": "City value where the job is posted."
},
"state": {
"type": "string",
"description": "State value where the job is posted."
},
"country": {
"type": "string",
"description": "Country value where the job is posted."
},
"location": {
"type": "string",
"description": "Location of the job posted."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"jobUpdatedDate": {
"type": "string",
"description": "Timestamp where the latest update was pushed to the job."
},
"createdDate": {
"type": "string",
"description": "Timestamp when the job was created."
},
"category": {
"type": "string",
"description": "Job Category."
},
"multiCategory": {
"type": "array",
"description": "List of categories where the job is posted to.",
"items": {
"type": "string",
"description": "category where the job is posted to."
}
},
"multiLocation": {
"type": "array",
"description": "List of locations where the job is posted.",
"items": {
"type": "string",
"description": "locations where the job is posted."
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| title | string | Title of the Job. |
| jobId | string | Job ID - unique field to identify the job. |
| city | string | City value where the job is posted. |
| state | string | State value where the job is posted. |
| country | string | Country value where the job is posted. |
| location | string | Location of the job posted. |
| locale | string | Locale of the site (Language_Country) - Example: en_US. |
| siteType | string | Persona Value - Example: Internal, External. |
| jobUpdatedDate | string | Timestamp where the latest update was pushed to the job. |
| createdDate | string | Timestamp when the job was created. |
| category | string | Job Category. |
| multiCategory | [string] | List of categories where the job is posted to. |
| multiLocation | [string] | List of locations where the job is posted. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status returned by the API."
},
"message": {
"type": "string",
"description": "Error Message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | Status returned by the API. |
| message | string | Error Message. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status returned by the API."
},
"data": {
"type": "object",
"description": "Response.",
"properties": {
"titles": {
"type": "array",
"description": "List of Titles.",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the job."
},
"jobId": {
"type": "string",
"description": "Job ID - Unique Identifier of the job."
},
"titleHtml": {
"type": "string",
"description": "Title of the job with highlighted tags."
}
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | Status returned by the API. |
| data | object | Response. |
| titles | [object] | List of Titles. |
| title | string | Title of the job. |
| jobId | string | Job ID - Unique Identifier of the job. |
| titleHtml | string | Title of the job with highlighted tags. |
copied!{
"type": "object",
"description": "Request to Search Jobs.",
"properties": {
"keywords": {
"type": "string",
"description": "Keyword to search."
},
"from": {
"type": "integer",
"description": "Starting point from which the data should be retrieved."
},
"size": {
"type": "integer",
"description": "Size of the response."
},
"booleanOperator": {
"type": "string",
"description": "Search operator accepts \"and\" / \"or\"."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"userType": {
"type": "string",
"description": "Type of the user - Internal or External User."
},
"orderBy": {
"type": "string",
"description": "Resultant order of jobs."
},
"facets": {
"type": "object",
"description": "Attributes and it's corresponding values to filter jobs.",
"properties": {
"city": {
"type": "array",
"items": {
"type": "string"
},
"description": "City filter will be applied based on the values present in the list."
},
"state": {
"type": "array",
"items": {
"type": "string"
},
"description": "State filter will be applied based on the values present in the list."
},
"country": {
"type": "array",
"items": {
"type": "string"
},
"description": "Country filter will be applied based on the values present in the list."
},
"category": {
"type": "array",
"items": {
"type": "string"
},
"description": "Category filter will be applied based on the values present in the list."
}
}
},
"ip": {
"type": "string",
"description": "User IP Address."
},
"locationData": {
"LocationData": {
"type": "object",
"properties": {
"latlong": {
"type": "string",
"description": "Latitude, Longitude of the location."
},
"location": {
"type": "string",
"description": "Location Value."
},
"radius": {
"type": "integer",
"description": "Radius to consider from the entered location."
},
"radiusUnit": {
"type": "string",
"description": "Radius unit to consider."
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| keywords | string | Keyword to search. |
| from | integer | Starting point from which the data should be retrieved. |
| size | integer | Size of the response. |
| booleanOperator | string | Search operator accepts "and" / "or". |
| locale | string | Locale of the site (Language_Country) - Example: en_US. |
| siteType | string | Persona Value - Example: Internal, External. |
| userType | string | Type of the user - Internal or External User. |
| orderBy | string | Resultant order of jobs. |
| facets | object | Attributes and it's corresponding values to filter jobs. |
| city | [string] | City filter will be applied based on the values present in the list. |
| state | [string] | State filter will be applied based on the values present in the list. |
| country | [string] | Country filter will be applied based on the values present in the list. |
| category | [string] | Category filter will be applied based on the values present in the list. |
| ip | string | User IP Address. |
| locationData | object | LocationData |
copied!{
"type": "object",
"properties": {
"latlong": {
"type": "string",
"description": "Latitude, Longitude of the location."
},
"location": {
"type": "string",
"description": "Location Value."
},
"radius": {
"type": "integer",
"description": "Radius to consider from the entered location."
},
"radiusUnit": {
"type": "string",
"description": "Radius unit to consider."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| latlong | string | Latitude, Longitude of the location. |
| location | string | Location Value. |
| radius | integer | Radius to consider from the entered location. |
| radiusUnit | string | Radius unit to consider. |
copied!{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status returned by the API."
},
"data": {
"type": "object",
"description": "Job Search Response data.",
"properties": {
"jobs": {
"type": "array",
"items": {
"JobNode": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the Job."
},
"jobId": {
"type": "string",
"description": "Job ID - unique field to identify the job."
},
"city": {
"type": "string",
"description": "City value where the job is posted."
},
"state": {
"type": "string",
"description": "State value where the job is posted."
},
"country": {
"type": "string",
"description": "Country value where the job is posted."
},
"location": {
"type": "string",
"description": "Location of the job posted."
},
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"description": "Persona Value - Example: Internal, External."
},
"jobUpdatedDate": {
"type": "string",
"description": "Timestamp where the latest update was pushed to the job."
},
"createdDate": {
"type": "string",
"description": "Timestamp when the job was created."
},
"category": {
"type": "string",
"description": "Job Category."
},
"multiCategory": {
"type": "array",
"description": "List of categories where the job is posted to.",
"items": {
"type": "string",
"description": "category where the job is posted to."
}
},
"multiLocation": {
"type": "array",
"description": "List of locations where the job is posted.",
"items": {
"type": "string",
"description": "locations where the job is posted."
}
}
}
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | Status returned by the API. |
| data | object | Job Search Response data. |
| jobs | array | JobNode |