{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetHrisStaffingEntitiesPositiveResponse",
"title": "GetHrisStaffingEntitiesPositiveResponse",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"data": {
"type": "object",
"properties": {
"next": {
"type": [
"string",
"null"
],
"description": "Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages."
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": "string",
"description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key."
},
"name": {
"type": [
"string",
"null"
],
"description": "The name/title of the staffing entity."
},
"model_type": {
"type": [
"string",
"null"
],
"enum": [
"JOB",
"POSITION",
"REQUISITION"
],
"description": "The remote model type of the record. Possible values are \"JOB\", \"POSITION\" or \"REQUISITION\". We recommend that users of our `create employee` endpoint ask the customer whether they want to hire into positions or requisitions."
},
"description": {
"type": [
"string",
"null"
],
"description": "A text description of the staffing entity \u2014 typically covering responsibilities, requirements, and scope. Commonly referred to as the \"job description\" in HRIS systems. May contain HTML, depending on the source system."
},
"status": {
"type": [
"string",
"null"
],
"enum": [
"OPEN_LIMITED",
"OPEN_UNLIMITED",
"PENDING",
"FROZEN",
"FILLED",
"CLOSED"
],
"examples": [
"OPEN_UNLIMITED"
],
"description": "The status of the staffing entity.\n OPEN_LIMITED: The staffing entity is open and has a limited number of openings. Refer to the `number_of_openings` field to get the number of openings.\n OPEN_UNLIMITED: The staffing entity is open and has an unlimited number of openings. Some enterprise systems refer to this as \"Evergreen\".\n PENDING: The staffing entity is pending approval or is waiting to be published.\n FROZEN: The staffing entity is frozen (hiring freeze) and does not accept applications/hires.\n FILLED: The staffing entity is filled (to its maximum capacity) and not available for new hires.\n CLOSED: The staffing entity is closed and not available for new hires."
},
"employment_types": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"remote_label": {
"type": "string",
"description": "The label of the employment type how it appears in the remote system."
},
"unified_type": {
"type": [
"string",
"null"
],
"enum": [
"FULL_TIME",
"PART_TIME",
"CONTRACT",
"INTERNSHIP",
"FREELANCE",
"WORKING_STUDENT",
"APPRENTICESHIP",
"TRAINING"
],
"description": "The unified type, how Kombo categorize this label."
}
},
"required": [
"remote_label",
"unified_type"
]
},
"description": "The employment types available for/used by the staffing entity. Use the `remote_label` for display in your UI as it is consistent with the language of the remote system. Use the `unified_type` for internal categorization as it is unified across all tools."
},
"number_of_openings": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308,
"description": "The number of openings for the staffing entity. Only meaningful for staffing entities with the status \"OPEN_LIMITED\"."
},
"parent_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the staffing entity\u2019s parent. Usually it\u2019s the position/job that was used to create the requisition. The ID can be used to retrieve the parent staffing entity from the `get staffing entity` endpoint."
},
"remote_url": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "URL to the staffing entity in the HRIS system. Use this to implement backlinks into the HRIS/Enterprise System."
},
"remote_created_at": {
"description": "The date and time the object was created in the remote system.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_updated_at": {
"description": "A timestamp retrieved from the remote system, describing when the resource was last updated.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"changed_at": {
"description": "The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.",
"type": "string",
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_deleted_at": {
"description": "The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"custom_fields": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "A key-value store of fields not covered by the schema. [Read more](/custom-fields)"
},
"integration_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object."
},
"key": {
"type": "string",
"description": "The key of the field in the remote system."
},
"type": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": "- `DEFAULT`: static fields in the remote system.\n- `CUSTOM`: fields that are created/editable by the user."
},
"value": {
"type": "null",
"description": "The field's value."
},
"label": {
"type": [
"string",
"null"
],
"description": "The label of the field. (not always available)"
}
},
"required": [
"id",
"key",
"type",
"label"
]
},
"description": "An array of selected passthrough integration fields. [Read more](/integration-fields)",
"examples": [
[
{
"id": "5NVFhMpB9Ah6by44tzNjZLyE",
"key": "firstName",
"type": "DEFAULT",
"value": "Frank",
"label": "First Name"
},
{
"id": "8nuajYpoRd5GnxEQaaWKUDYQ",
"key": "customTshirtSize",
"type": "CUSTOM",
"value": "XL",
"label": "T-Shirt Size"
}
]
]
},
"remote_data": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Includes the data fetched from the remote system.\nPlease be aware that including this in you scope config might violate other\nscopes that are set.\n\nRemote data always has the endpoint path that we got the data from as the\ntop level key. For example, it could look like: `{ \"/companies\": { ... }}`\n\nThis is not available on all plans. Reach out to Kombo if you need it."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key."
},
"name": {
"type": [
"string",
"null"
],
"description": "The work location\u2019s name"
},
"type": {
"type": [
"string",
"null"
],
"description": "The work location\u2019s type. A freeform string."
}
},
"required": [
"id",
"remote_id",
"name",
"type"
],
"examples": [
{
"id": "22st2Ji8XpncEYEak8mvQgQF",
"remote_id": "1348",
"name": "Kombo HQ",
"type": "OFFICE"
}
]
},
"description": "The physical work locations associated with this staffing entity. A position or requisition can be linked to one or more offices or sites where the role is to be filled."
},
"legal_entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key."
},
"name": {
"type": [
"string",
"null"
],
"description": "The legal entity\u2019s name."
}
},
"required": [
"id",
"remote_id",
"name"
],
"examples": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "ACME Inc."
}
]
},
"description": "The legal entities (companies or sub-companies) associated with this staffing entity. Indicates which employing entities within the organization the position or requisition belongs to."
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": "string",
"description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key."
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the group."
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"DEPARTMENT",
"TEAM",
"COST_CENTER"
],
"description": "Type of the group."
}
},
"required": [
"id",
"remote_id",
"name",
"type"
],
"examples": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "Customer Success",
"type": "TEAM"
}
]
},
"description": "The organizational groups (such as departments, teams, or cost centers) associated with this staffing entity."
}
},
"required": [
"id",
"remote_id",
"name",
"model_type",
"description",
"status",
"number_of_openings",
"parent_id",
"remote_url",
"remote_created_at",
"remote_updated_at",
"changed_at",
"remote_deleted_at",
"custom_fields",
"integration_fields",
"remote_data",
"locations",
"legal_entities",
"groups"
]
}
}
},
"required": [
"next",
"results"
],
"examples": [
{
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Software Engineer",
"model_type": "POSITION",
"description": "Description of the position",
"status": "OPEN_UNLIMITED",
"employment_types": [
{
"remote_label": "Vollzeit",
"unified_type": "FULL_TIME"
}
],
"number_of_openings": null,
"parent_id": "KGaJ5XaVPob8mYVfD49W4DGB",
"remote_url": "https://example.com/position/32",
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"custom_fields": {},
"integration_fields": [],
"remote_data": null,
"locations": [
{
"id": "22st2Ji8XpncEYEak8mvQgQF",
"remote_id": "1348",
"name": "Kombo HQ",
"type": "OFFICE"
}
],
"legal_entities": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "ACME Inc."
}
],
"groups": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "Customer Success",
"type": "TEAM"
}
]
}
]
}
]
}
},
"required": [
"status",
"data"
]
}