GuidesAPI Reference
API Reference
  1. Partner API
  2. /jobs

/jobs

post
https://partners.apploi.com/jobs
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

The ID of the application form template to use. If not provided, defaults to the team's Quick Apply template.

string
length ≥ 1

The brand/company name (Company Alias) for the job posting. If not provided, defaults to the team's company profile brand name. When job_confidential is true, you can set this explicitly to display a custom alias instead of the default company name.

string
required
length ≥ 1

The city of the job location

string
required
length ≥ 1

The country of the job location

string
length ≤ 5

The state for credentialing purposes (e.g., 'CA', 'NY'). Required if credentialing_verification_enabled is true.

boolean

Whether credentialing verification is enabled for this job. If true, role_type, credentialing_state, and credentialing_when_to_send are required.

string
enum

When to send credentialing verification requests. Required if credentialing_verification_enabled is true. Valid values: 'manual' (request on demand) or 'quick_apply' (request after apply).

Allowed:
integer

The ID of the department this job belongs to.

string
required
length ≥ 1

The job description

integer

The ID of the interview guide template to use for this job.

job_attributes
object

Additional custom attributes for the job.

boolean

Whether the job is private (not posted to public job boards). When true, the brand_name field can be set explicitly to display a custom Company Alias; otherwise defaults to the team's company profile name. Note: This is separate from show_company_logo - a job can be private but still show the company logo.

string
required
length ≥ 1

The title/name of the job posting

string
enum
required

The type of employment: FullTime, PartTime, Both (full and part time), PerDiem, Shifts, or Temporary

Allowed:
string
enum

The minimum education level required.

boolean
required

Whether the job is published and visible to applicants

question_template_mappings
array of objects

Optional list of template mapping entries. Each entry must supply template_id, order_num, app_is_completed_here, and is_interview_guide.

question_template_mappings
boolean

Whether a resume is required for this job application.

string
length ≤ 30

The role type for credentialing purposes. Required if credentialing_verification_enabled is true.

number
≥ 0

The maximum salary amount. Required when salary_type is RANGE or EXACT_AMOUNT.

number
≥ 0

The minimum salary amount. Required when salary_type is RANGE.

string
enum

The salary rate period (e.g., PER_HOUR, PER_YEAR). Required when salary_type is specified.

string
enum

The salary type: RANGE requires salary_min, salary_max, and salary_rate. EXACT_AMOUNT requires salary_max and salary_rate. Omit this field to not display salary.

Allowed:
boolean

Whether to display the company logo on the job posting. Defaults to true. When false, creates a 'blind ad' - the job will not be visible on your company website or profile page, and cannot be sponsored on Indeed or Facebook. The brand_name field can be used as an alias when this is false.

string
required
length ≥ 1

The state/province of the job location

string
required
length ≥ 1

The street address of the job location

integer
required

The ID of the team this job belongs to

integer
0 to 100

The minimum years of experience required.

string
required
length ≥ 1

The postal/zip code of the job location

Responses

400

400 response

403

Invalid Token

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago