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

Name
Type
Description

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

Name
Type
Description

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.

{
  "is_error": false,
  "result": {
    "id": "3c2914bb-b31b-47ab-8976-afaa2d995503"
  }
}

Examples:

curl -X POST "${BASE_URL}/api/v1/jobs" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d '{
  "title": "Digital Marketing Specialist",
  "description": "Digital Marketing Specialist sought for fast-paced agency. Must have expertise in SEO, PPC, and content strategy. Google Analytics certification preferred.",
  "status": "open",
  "job_posting_urls": [
    "https://www.marketinghub.com/jobpost/digi-mark-special-1003"
  ],
  "remote_id": "remote-id_from-originating-system"
}'

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

Name
Type
Description

id*

string

UUID id of the job

Headers

Name
Type
Description

Authorization*

string

Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>

{
  "is_error": false,
  "result": {
    "id": "3c2914bb-b31b-47ab-8976-afaa2d995503",
    "title": "Job Title",
    "description": "Job Description",
    "status": "open",
    "job_posting_urls": ["https://endorsed.ai/jobPosting/example"],
    "remote_id": "ef29a39b-b143-4491-9f84-038b8806f950",
    "created_at": "2023-09-25T22:06:01.000Z",
    "modified_at": "2023-09-25T22:06:01.000Z"
  }
}

Examples:

curl -X GET "${BASE_URL}/api/v1/jobs/remote.remote-id_from-originating-system" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"

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

Name
Type
Description

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

Name
Type
Description

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.

{
  "is_error": false,
  "result": {
    "id": "3c2914bb-b31b-47ab-8976-afaa2d995503"
  }
}

Examples:

curl -X PUT "${BASE_URL}/api/v1/jobs/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d '{
  "title": "Senior Web Engineer",
  "description": "Experienced Web Developer needed to join our dynamic tech team. Proficient in Javascript, HTML, and CSS. Familiarity with React.JS a plus.",
  "status": "closed",
  "job_posting_urls": [
    "https://www.techjobsite.com/listings/web-dev-0923"
  ]
}'

Partially update an existing job

PATCH https://endorsed.ai/api/v1/jobs/{id}

Partially updates an existing job by it's UUID id.

Headers

Name
Type
Description

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

Name
Type
Description

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.

{
  "is_error": false,
  "result": {
    "id": "3c2914bb-b31b-47ab-8976-afaa2d995503"
  }
}

Examples:

curl -X PATCH "${BASE_URL}/api/v1/jobs/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d '{
  "status": "open",
  "job_posting_urls": [
    "https://www.marketinghub.com/jobpost/digi-mark-special-1003"
  ]
}'

Last updated

© 2024 Endorsed