Opening Object Schema
The Opening object contains the details of an opening.
| Field | Field Type | Description |
|---|---|---|
| id | Integer | Unique identifier for this opening object. |
| title | String | Name of the opening. E.g. "Software Engineer" or "Project Manager" |
| description | String | A more detailed description about the opening. |
| team | String | The name of the team within the organization who is hiring for this opening. E.g. "Sales and Marketing" or "Engineering". |
| state | String | Current state of the opening. Possible values - "Draft", "Published Internally", "Published", "Not accepting candidates", "Archived" |
| position_type | String | An enumeration that can have any of the values contract, full_time, part_time |
| is_remote_allowed | Boolean | Whether the position allows working remotely. |
| location.city | String | City of the opening location |
| location.state | String | State of the opening location |
| location.zipcode | String | ZipCode of the opening location |
| location.country | String | Country of the opening location |
| is_private | Boolean | Whether this opening is published on the job site |
| hosted_url | String | Trakstar Hire allows you to create a branded careers site for your organization. This field gives you the URL of the Opening within the careers site. |
| is_private | Boolean | Indicates whether this opening is marked as a private opening. For more details refer to [this Trakstar Hire features page on Private openings |
| application_email | String | Trakstar Hire allows you to add candidates to an opening by sending the candidate resumes to an email address. |
| is_archived | Boolean | Trakstar Hire allows you to archive an opening, once you are done hiring for it. This field indicates whether the field is archived. |
| created_date | Datetime | Timestamp of when the opening details were created |
| modified_date | Datetime | Timestamp of when the opening details were last modified. |
| stages | Array | List of stages (id, name & type of stage) configured in the Hiring Workflow for a particular opening. E.g. Screening, Telephone Interview, Make Offer etc. |
| application_form_fields | Array | List of configured questions that an applicant will have to answer while applying via the Trakstar Hire-hosted careers page. (link to which is available in the hosted_url field) |
| additional_fields | Array | List of additional fields and their corresponding values |