Position Schema

The position object:

Field

Type

Description

uid

string

Position UID

name

string

Position name

internal_name

string

Position internal name. Permission to read positions internal name is required.

status

string

One of the following:
open
on hold
closed

is_discreet

boolean

true means that the position is only visible to teammates on the position's hiring team.

is_published

boolean

true means that the position is published on the company's website.

internal_name

string

department

string

email

string

Position’s email – candidates can send resume to this email address to apply for this position.

URL

string

URL of the position in Recruit, accessible for Recruit users only.

url_recruit_hosted_page

string

URL of the position’s page on the Recruit-hosted website. It is possible to refer applicants to this web page.

url_active_page

string

URL of the current position’s page according to the position’s settings. Could be either on the company’s website or on the Recruit-hosted website. It is possible to refer applicants to this web page.

experience_level

string

The position's Seniority field.

employment_type

string

The position's Employment field.

internal_use_custom_id

string

The position’s id as defined by the company (not to be confused with the UID of the position).

picture_url

string

URL for the public position image for display and share on social media.

time_updated

timestamp

company_name

string

position_url

string

URL for receiving the position object through the API.

is_talent_pool

boolean

true means that this position is a talent pool

location

object

location.name

string

location.country

string

location.city

string

location.state

string

location.postal_code

string

location.street_name

string

location.arrival_instructions

string

location.street_number

string

location.timezone

string

location.uid

string

salary_range

object

Position salary range. Permission to read positions salary range is required.

salary_range.min

int

salary_range.max

int

salary_range.currency_code

string

Currency using 3 letters code (ISO 4217)

salary_range.period

string

One of the following:
hourly
weekly
monhtly
annually

categories

array

Custom categories.

categories[].name

string

categories[].value

string

categories[].order

int

details

array

Free-form text details.

details[].name

string

details[].value

string

HTML

details[].order

int

users

object

users.lead_recruiter

object

Receiving this object requires permission.

users.lead_recruiter.first_name

string

users.lead_recruiter.last_name

string

users.lead_recruiter.email

string

users.lead_recruiting_coordinator

object

Receiving this object requires permission.

users.lead_recruiting_coordinator.first_name

string

users.lead_recruiting_coordinator.last_name

string

users.lead_recruiting_coordinator.email

string

referral_bonus

object

Enabled only for employee portal

referral_bonus.value

string

referral_bonus.is_company_default

boolean

true if the value that returns is the company default.
false if the value is set for a specific position.

{  
  "uid": "87.405",
  "name": "Account Executive, Austin",
  "status": "open",
  "is_discreet": false,
  "is_published": true,
  "department": "Sales",
  "email": "[email protected]",
  "URL": "http://app.comeet.co/app/?goto_url=/req/1234",
  "url_recruit_hosted_page": "https://www.comeet.co/jobs/companyname/30.005/account-executive-austin/87.405",
  "url_active_page": "https://www.comeet.co/jobs/companyname/30.005/account-executive-austin/87.405",
  "employment_type": "Full-time",
  "experience_level": "Intermediate",
  "internal_use_custom_id": null,
  "picture_url": "https://comeet-euw-app.s3.amazonaws.com/53/b5ac4af700dfe6d749a862f7ba267f288f6cb575",
  "time_updated": "2017-05-26T14:22:46Z",
  "company_name": "Company Name",
  "position_url": "https://www.comeet.co/careers-api/2.0/company/30.005/positions/87.405?token=359F1DD13E1DD1DD1A813E6A6A",
  "is_talent_pool": false,
  "location":{  
    "name": "Austin, TX",
    "country": "US",
    "city": "Austin",
    "state": "TX",
    "postal_code": "",
    "street_name": "",
    "arrival_instructions": null,
    "street_number": "",
    "timezone": "America/Iqaluit",
    "uid": "D00.000"
  },
   "salary_range": {
   	"min": 200000,
   	"max": 40000,
   	"currency_code": "USD",
   	"period": "Monthly"
  },
  "categories":[  
    {  
      "name": "Territory",
      "value": "USA",
      "order": 1
    }
    //...
  ],
  "referral_bonus"”: {
    	"“value"”: "200 USD",
			"is_company_default": true
},

  "details":[  
    {  
      "name": "Description",
      "value": "We are looking for ...",
      "order": 1
    },
    {  
      "name": "Requirements",
      "value": "Candidates should have ...",
      "order": 2
    }
    //,,,
  ],
  "users": {
    "lead_recruiter": {
      "first_name": "Brandon",
      "last_name": "Liao",
      "email": "[email protected]"
    },
    "lead_recruiting_coordinator": {
      "first_name": "Stephanie",
      "last_name": "Simon",
      "email": "[email protected]"
    }
  }
}