Create job

cURL

curl --request POST \
  --url https://api.hirehive.com/v1.0/{company_id}/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "owner_id": "<string>",
  "status": "drafted",
  "type": "full_time",
  "experience": "na",
  "deadline": {
    "closes_at": "2023-11-07T05:31:56Z",
    "auto_close": true
  },
  "description": "<string>",
  "location": {
    "city": "<string>",
    "state": {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    },
    "country": {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    },
    "remote": "not_remote"
  },
  "salary": "<string>",
  "job_code": "<string>",
  "category": {
    "id": "<string>",
    "name": "<string>"
  },
  "language": {
    "id": "<string>",
    "name": "<string>",
    "code": "<string>"
  },
  "assigned_team": {
    "assigned_users": [
      "<string>"
    ],
    "recruiter_ids": [
      "<string>"
    ]
  },
  "notifications": {
    "new_application_email": [
      "<string>"
    ]
  },
  "application_form": {
    "base_form": {
      "current_title": "off",
      "current_company": "off",
      "location": "off",
      "phone": "off",
      "resume": "off",
      "cover_letter": "off"
    },
    "additional_form_ids": [
      "<string>"
    ]
  },
  "auto_responder": {
    "id": "<string>",
    "email_subject": "<string>",
    "email_body": "<string>"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}
'

{
  "data": {
    "id": "<string>",
    "assigned_team": {
      "assigned_users": [
        "<string>"
      ],
      "recruiter_ids": [
        "<string>"
      ]
    },
    "notifications": {
      "new_application_email": [
        "<string>"
      ]
    },
    "application_form": {
      "base_form": {
        "current_title": "off",
        "current_company": "off",
        "location": "off",
        "phone": "off",
        "resume": "off",
        "cover_letter": "off"
      },
      "additional_form_ids": [
        "<string>"
      ]
    },
    "auto_responder": {
      "id": "<string>",
      "email_subject": "<string>",
      "email_body": "<string>"
    },
    "tags": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "deadline": {
      "closes_at": "2023-11-07T05:31:56Z",
      "auto_close": true
    },
    "title": "<string>",
    "description": "<string>",
    "location": {
      "city": "<string>",
      "state": {
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "country": {
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "remote": "not_remote"
    },
    "owner_id": "<string>",
    "status": "drafted",
    "type": "full_time",
    "experience": "na",
    "salary": "<string>",
    "job_code": "<string>",
    "created_date": "2023-11-07T05:31:56Z",
    "published_date": "2023-11-07T05:31:56Z",
    "category": {
      "id": "<string>",
      "name": "<string>"
    },
    "language": {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    },
    "job_ads": [
      {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "job_board": "indeed",
        "status": "unknown",
        "budget": 123,
        "meta": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "apply_url": "<string>"
  }
}

POST

v1.0

{company_id}

jobs

cURL

curl --request POST \
  --url https://api.hirehive.com/v1.0/{company_id}/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "owner_id": "<string>",
  "status": "drafted",
  "type": "full_time",
  "experience": "na",
  "deadline": {
    "closes_at": "2023-11-07T05:31:56Z",
    "auto_close": true
  },
  "description": "<string>",
  "location": {
    "city": "<string>",
    "state": {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    },
    "country": {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    },
    "remote": "not_remote"
  },
  "salary": "<string>",
  "job_code": "<string>",
  "category": {
    "id": "<string>",
    "name": "<string>"
  },
  "language": {
    "id": "<string>",
    "name": "<string>",
    "code": "<string>"
  },
  "assigned_team": {
    "assigned_users": [
      "<string>"
    ],
    "recruiter_ids": [
      "<string>"
    ]
  },
  "notifications": {
    "new_application_email": [
      "<string>"
    ]
  },
  "application_form": {
    "base_form": {
      "current_title": "off",
      "current_company": "off",
      "location": "off",
      "phone": "off",
      "resume": "off",
      "cover_letter": "off"
    },
    "additional_form_ids": [
      "<string>"
    ]
  },
  "auto_responder": {
    "id": "<string>",
    "email_subject": "<string>",
    "email_body": "<string>"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}
'

{
  "data": {
    "id": "<string>",
    "assigned_team": {
      "assigned_users": [
        "<string>"
      ],
      "recruiter_ids": [
        "<string>"
      ]
    },
    "notifications": {
      "new_application_email": [
        "<string>"
      ]
    },
    "application_form": {
      "base_form": {
        "current_title": "off",
        "current_company": "off",
        "location": "off",
        "phone": "off",
        "resume": "off",
        "cover_letter": "off"
      },
      "additional_form_ids": [
        "<string>"
      ]
    },
    "auto_responder": {
      "id": "<string>",
      "email_subject": "<string>",
      "email_body": "<string>"
    },
    "tags": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "deadline": {
      "closes_at": "2023-11-07T05:31:56Z",
      "auto_close": true
    },
    "title": "<string>",
    "description": "<string>",
    "location": {
      "city": "<string>",
      "state": {
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "country": {
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "remote": "not_remote"
    },
    "owner_id": "<string>",
    "status": "drafted",
    "type": "full_time",
    "experience": "na",
    "salary": "<string>",
    "job_code": "<string>",
    "created_date": "2023-11-07T05:31:56Z",
    "published_date": "2023-11-07T05:31:56Z",
    "category": {
      "id": "<string>",
      "name": "<string>"
    },
    "language": {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    },
    "job_ads": [
      {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "job_board": "indeed",
        "status": "unknown",
        "budget": 123,
        "meta": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "apply_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_id

string<string>

required

Body

application/json

title

string

required

The title of the job.

Required string length: 1 - 100

owner_id

string<int32>

required

The user_id of the job owner.

status

enum<string>

required

The status of the job.

Available options:

drafted,

published,

closed,

internal

type

enum<string>

required

The employment type.

Available options:

full_time,

part_time,

contract,

temporary,

other,

internship,

volunteer

experience

enum<string>

required

The experience type.

Available options:

na,

intern,

entry_level,

mid_level,

senior

deadline

object

required

Show child attributes

deadline.closes_at

string<date-time> | null

deadline.auto_close

boolean | null

description

string

Maximum string length: 100000

location

object

The location object.

Show child attributes

location.city

string

required

The city the job is based in.

Maximum string length: 150

location.state

object

The state if the job is based in USA.

Show child attributes

location.state.id

string<int32>

location.state.name

string

The full name of the state.

location.state.code

string

The 2 letter code of the state.

location.country

object

The country of the job.

Show child attributes

location.country.id

string<int32>

location.country.name

string

The full name of the country.

location.country.code

string

The 2 letter alpha iso code of the country.

location.remote

enum<string> | null

Available options:

not_remote,

wfh_flexible,

fully_remote,

covid_remote

salary

string

The salary of the job.

job_code

string

A code associated with the job. This is internal.

Response

data

object

Show child attributes

data.id

string<int32>

required

The id of the job, format job_abc123.

data.assigned_team

object

required

Show child attributes

data.assigned_team.assigned_users

string<int32>[]

required

data.assigned_team.recruiter_ids

string[]

required

data.notifications

object

required

Show child attributes

data.notifications.new_application_email

string<int32>[]

required

data.application_form

object

required

Show child attributes

data.application_form.base_form

object

Show child attributes

data.application_form.base_form.current_title

enum<string> | null

Available options:

off,

optional,

required

data.application_form.base_form.current_company

enum<string> | null

Available options:

off,

optional,

required

data.application_form.base_form.location

enum<string> | null

Available options:

off,

optional,

required

data.application_form.base_form.phone

enum<string> | null

Available options:

off,

optional,

required

data.application_form.base_form.resume

enum<string> | null

Available options:

off,

optional,

required

data.application_form.base_form.cover_letter

enum<string> | null

Available options:

off,

optional,

required

data.application_form.additional_form_ids

string<int32>[]

data.auto_responder

object

required

Show child attributes

data.auto_responder.id

string<int32> | null

The id of the default auto responder email template

data.auto_responder.email_subject

string

The subject of the auto responder if using a custom email for this job otherwise null.

data.auto_responder.email_body

string

The body of the auto responder if using a custom email for this job otherwise null.

data.tags

object[]

required

Show child attributes

data.tags.id

string<int32>

data.tags.name

string

data.deadline

object

required

Show child attributes

data.deadline.closes_at

string<date-time> | null

data.deadline.auto_close

boolean | null

data.title

string

The title of the job.

data.description

string

Maximum string length: 100000

data.location

object

The location object.

Show child attributes

data.location.city

string

required

The city the job is based in.

Maximum string length: 150

data.location.state

object

The state if the job is based in USA.

Show child attributes

data.location.state.id

string<int32>

data.location.state.name

string

The full name of the state.

data.location.state.code

string

The 2 letter code of the state.

data.location.country

object

The country of the job.

Show child attributes

data.location.country.id

string<int32>

data.location.country.name

string

The full name of the country.

data.location.country.code

string

The 2 letter alpha iso code of the country.

data.location.remote

enum<string> | null

Available options:

not_remote,

wfh_flexible,

fully_remote,

covid_remote

data.owner_id

string<int32>

The user_id of the job owner.

data.status

enum<string>

The status of the job.

Available options:

drafted,

published,

closed,

internal

data.type

enum<string>

The employment type.

Available options:

full_time,

part_time,

contract,

temporary,

other,

internship,

volunteer

data.experience

enum<string>

The experience type.

Available options:

na,

intern,

entry_level,

mid_level,

senior

data.salary

string

The salary of the job.

data.job_code

string

A code associated with the job. This is internal.

data.created_date

string<date-time>

The date the job was created.

data.published_date

string<date-time> | null

The date the job was last published. This will be null if the job was never published.

data.category

object

Show child attributes

data.category.id

string<int32>

data.category.name

string

data.language

object

Show child attributes

data.language.id

string<int32>

data.language.name

string

data.language.code

string

data.job_ads

object[]

Show child attributes

data.job_ads.id

integer<int32>

data.job_ads.created_at

string<date-time>

data.job_ads.expires_at

string<date-time> | null

data.job_ads.job_board

enum<string>

Available options:

indeed

data.job_ads.status

enum<string>

Available options:

unknown,

active,

paused,

expired

data.job_ads.budget

number<decimal>

data.job_ads.meta

object[]

Show child attributes

data.job_ads.meta.key

string

data.job_ads.meta.value

string

data.apply_url

string

Get job by id Update job

⌘I

Getting Started

Endpoints

Webhooks

Authorizations

Path Parameters

Body

Response