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:
Field | Type | Description |
---|---|---|
uid | string | Position UID |
name | string | The name of the position of the public name if set |
department | string | |
string | Position’s email – candidates can send resume to this email address to apply for this position. | |
url_comeet_hosted_page | string | URL of the position’s page on the Comee-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 Comeet-hosted website. It is possible to refer applicants to this web page. |
employment_type | string | |
experience_level | string | |
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 of the public position image for display and sharing on social media. |
time_updated | timestamp | |
company_name | string | |
workplace_type | string | One of the following: On-site , Hybrid or Remote |
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.is_remote | boolean | The remote property will be deprecated by Dec 31 2023 – Use workplace_type instead.true Indicates that this is a remote position. |
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 |
{
"uid":"87.405",
"name":"Account Executive, Austin",
"department":"Sales",
"workplace_type": "Remote",
"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"
},
"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
}
//,,,
]
}