Jobs
A company's job to which candidates may apply.
Create a job
POST
https://endorsed.ai/api/v1/jobs
Creates a new job and returns the job's UUID id.
Headers
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens
endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json
. If not set, defaults to application/json
Request Body
title*
string
The title of the job
description*
string
The description of the job
status*
string
The current status of the job:
open
,
archived
, or
closed
job_posting_urls
string[]
List of publicly visible job posting urls
remote_id*
string
The
id
of the job from the originating system
auto_evaluation_behavior
string
auto_evaluate_nominations
,
auto_nominate_and_evaluate_candidates
, or
null
default_nomination_stage_id
string
The default nomination stage id (UUID) to be used for Endorsed to automatically generate nominations. Required if the auto_evaluation_behavior
is auto_nominate_and_evaluate_candidates
.
Examples:
Get an existing job
GET
https://endorsed.ai/api/v1/jobs/{id}
Get an existing job by it's UUID id or by a remote id. Remote ids MUST be structured by remote.<id>
Path Parameters
id*
string
UUID id of the job
Headers
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens
endpoint. Example: Bearer <ACCESS_TOKEN>
Examples:
Update or upserts an existing job
PUT
https://endorsed.ai/api/v1/jobs/{id}
Updates an existing job by it's UUID id or upserts a job by a remote id. Remote ids MUST be structured by remote.<id>
.
Headers
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens
endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json
. If not set, defaults to application/json
Request Body
title*
string
The title of the job
description*
string
The description of the job
status*
string
The current status of the job:
open
,
archived
, or
closed
job_posting_urls
string[]
List of publicly visible job posting urls
auto_evaluation_behavior
string
auto_evaluate_nominations
,
auto_nominate_and_evaluate_candidates
, or
null
default_nomination_stage_id
string
The default nomination stage id (UUID) to be used for Endorsed to automatically generate nominations. Required if the auto_evaluation_behavior
is auto_nominate_and_evaluate_candidates
.
Examples:
Partially update an existing job
PATCH
https://endorsed.ai/api/v1/jobs/{id}
Partially updates an existing job by it's UUID id.
Headers
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens
endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json
. If not set, defaults to application/json
Request Body
title
string
The title of the job
description
string
The description of the job
status
string
The current status of the job:
open
,
archived
, or
closed
job_posting_urls
string[]
List of publicly visible job posting urls
auto_evaluation_behavior
string
auto_evaluate_nominations
,
auto_nominate_and_evaluate_candidates
, or
null
default_nomination_stage_id
string
The default nomination stage id (UUID) to be used for Endorsed to automatically generate nominations. Required if the auto_evaluation_behavior
is auto_nominate_and_evaluate_candidates
.
Examples:
Last updated