Jobs

Jobs represent open positions within an organization. Each job can have applicants, be assigned to a category and pipeline, and include custom application questions.

Create job

Create a new job posting for an organization.

Parameters

title

string

required

The job title (minimum 1 character)

string

required

The organization ID to create the job for

Response

error

boolean

Indicates if an error occurred

message

string | object

Success or error message. If validation fails, contains field-specific errors.

job

object

The created job object

Show properties

string

Unique identifier for the job

title

string

Job title

content

string

Job description/content (initialized as empty string)

organizationId

string

ID of the parent organization

Update job

Update an existing job’s details.

Parameters

job

object

required

The job object with updated fields

Show properties

string

required

Job ID

title

string

Job title

type

enum

Employment typeOptions: fulltime, parttime, internship, contract

status

enum

Job statusOptions: DRAFT, PUBLISHED, ARCHIVED, CLOSED

locationMode

enum

Work location modeOptions: ONSITE, REMOTE, HYBRID

content

string

Full job description (supports markdown/HTML)

country

string | null

Country location (set to empty string or null to clear)

city

string | null

City location (set to empty string or null to clear)

address

string | null

Full address

remote

boolean

Whether the position is remote (legacy field, prefer locationMode)

salaryMin

number | null

Minimum salary

salaryMax

number | null

Maximum salary

currency

string

Salary currency (defaults to “USD”)

salaryInterval

enum | null

Salary payment intervalOptions: HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY

experienceLevel

enum | null

Required experience levelOptions: ENTRY, MID, SENIOR, LEAD, EXECUTIVE

pipelineId

string | null

ID of the hiring pipeline to use for applicants

questions

array

Custom application questions

Show question object

type

string

required

Question type: SHORT_ANSWER, LONG_ANSWER, SELECT, CHECKBOX, etc.

label

string

required

Question text

placeholder

string

Placeholder text for input

required

boolean

Whether the question is required (defaults to false)

options

string[]

Options for SELECT or MULTI_SELECT questions

order

number

Display order (defaults to 0)

categoryId

string | null

required

Job category ID, or “none”/null to remove category assignment

Response

boolean

Indicates if the update was successful

error

boolean

Indicates if an error occurred

message

string

Success or error message. Returns “Only administrator can perform this action” if unauthorized.

List jobs

Get all jobs for an organization.

Parameters

organizationId

string

required

The organization ID

Response

error

boolean

Indicates if an error occurred

jobs

object

Container object with jobs array

Show properties

jobs

array

Array of job objects ordered by creation date (newest first)

Show job object

string

Job ID

title

string

Job title

type

enum

Employment type (fulltime, parttime, internship, contract)

status

enum

Job status (DRAFT, PUBLISHED, ARCHIVED, CLOSED)

locationMode

enum

Location mode (ONSITE, REMOTE, HYBRID)

content

string | null

Job description

country

string | null

Country location

city

string | null

City location

salaryMin

number | null

Minimum salary

salaryMax

number | null

Maximum salary

currency

string

Salary currency

experienceLevel

enum | null

Required experience level

createdAt

datetime

Creation timestamp

updatedAt

datetime

Last update timestamp

applicants

array

Array of applicant objects ordered by creation date

message

string

Error message if organization not found

Job fields reference

Type (employment type)

fulltime / FULLTIME - Full-time position
parttime / PARTTIME - Part-time position
internship / INTERNSHIP - Internship
contract / CONTRACT - Contract position

JobStatus

DRAFT - Job is being drafted
PUBLISHED - Job is publicly visible
ARCHIVED - Job is archived
CLOSED - Job is no longer accepting applications

LocationMode

ONSITE - Work from office
REMOTE - Work remotely
HYBRID - Mix of onsite and remote

SalaryInterval

HOURLY - Hourly rate
DAILY - Daily rate
WEEKLY - Weekly salary
MONTHLY - Monthly salary
QUARTERLY - Quarterly salary
YEARLY - Annual salary

ExperienceLevel

ENTRY - Entry level (0-2 years)
MID - Mid level (2-5 years)
SENIOR - Senior level (5-10 years)
LEAD - Lead/Staff level (10+ years)
EXECUTIVE - Executive level

Overview

Resources

Create job

Parameters

Response

Update job

Parameters

Response

List jobs

Parameters

Response

Job fields reference

Type (employment type)

JobStatus

LocationMode

SalaryInterval

ExperienceLevel

Build docs developers (and LLMs) love

Overview

Resources

​Create job

​Parameters

​Response

​Update job

​Parameters

​Response

​List jobs

​Parameters

​Response

​Job fields reference

​Type (employment type)

​JobStatus

​LocationMode

​SalaryInterval

​ExperienceLevel

Build docs developers (and LLMs) love

Create job

Parameters

Response

Update job

Parameters

Response

List jobs

Parameters

Response

Job fields reference

Type (employment type)

JobStatus

LocationMode

SalaryInterval

ExperienceLevel