📘

Model Structure and Fields

A position data model is a JSON object, therefore, when planning your code, address the position data as a dictionary and not as an array. It means that any code that uses the position model cannot rely on a fixed order of fields in the modal. Specifically, assume that the order of the model fields may change and new fields may be added in different places in the model as it evolves over time.

The position object:

FieldTypeDescription
uidstringPosition UID
namestringThe name of the position of the public name if set
departmentstring
emailstringPosition’s email – candidates can send resume to this email address to apply for this position.
url_comeet_hosted_pagestringURL of the position’s page on the Comee-hosted website. It is possible to refer applicants to this web page.
url_active_pagestringURL of the current position’s page according to the position’s settings. Could be either on the company’s website or on the Comeet-hosted website. It is possible to refer applicants to this web page.
employment_typestring
experience_levelstring
internal_use_custom_idstringThe position’s id as defined by the company (not to be confused with the UID of the position).
picture_urlstringURL of the public position image for display and sharing on social media.
time_updatedtimestamp
company_namestring
locationobject
location.namestring
location.countrystring
location.citystring
location.statestring
location.postal_codestring
location.street_namestring
location.arrival_instructionsstring
location.street_numberstring
location.timezonestring
location.is_remotebooleantrue Indicates that this is a remote position.
categoriesarrayCustom categories.
categories[].namestring
categories[].valuestring
categories[].orderint
detailsarrayFree-form text details.
details[].namestring
details[].valuestringHTML
details[].orderint
usersobject
users.hiring_managercontact objectRetrieving this object requires permission.
Properties: first_name,
last_name, email
users.lead_recruitercontact objectRetrieving this object requires permission.
Properties: first_name,
last_name, email
users.lead_recruiting_coordinatorcontact objectRetrieving this object requires permission.
Properties: first_name,
last_name, email
{  
  "uid":"87.405",
  "name":"Account Executive, Austin",
  "department":"Sales",
  "email":"[email protected]",
  "url_comeet_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",
  "location":{  
    "name":"Austin, TX",
    "country":"US",
    "city":"Austin",
    "state":"TX",
    "postal_code":"",
    "street_name":"",
    "arrival_instructions":null,
    "street_number":"",
    "timezone":"America/Iqaluit",
    "is_remote": false
  },
  "categories":[  
    {  
      "name":"Territory",
      "value":"USA",
      "order":1
    }
    //...
  ],
  "details":[  
    {  
      "name":"Description",
      "value":"We are looking for ...",
      "order":1
    },
    {  
      "name":"Requirements",
      "value":"Candidates should have ...",
      "order":2
    }
    //,,,
  ]
}