> ## Documentation Index > Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get employee skill proficiency ratings > Retrieve all employee skill proficiency ratings. This feature is currently available for the following integrations: You'd like to see this feature for another integration? Please reach out! We're always happy to discuss extending our coverage. Retrieve skill proficiency ratings on employees. Each row is one rating, differentiated by `rating_source` – the same employee and skill can have several rows (e.g. a `SELF` and an `EXTERNAL` rating). Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)` ## OpenAPI ````yaml GET /hris/skill-proficiency-ratings openapi: 3.1.0 info: title: Kombo API version: 1.0.0 servers: - url: https://api.kombo.dev/v1 description: Kombo EU API - url: https://api.us.kombo.dev/v1 description: Kombo US API security: - ApiKey: [] tags: - name: General - name: Kombo Connect description: >- Endpoints for Kombo Connect, our end-user-facing flow for setting up new integrations. - name: Unified HRIS API description: Unified endpoints to access all the HR concepts you might need. - name: Unified ATS API description: Unified endpoints to access all the ATS concepts you might need. - name: Unified ATS (Assessment & Background Check) API description: >- Unified endpoints to operate Assessments and Background Checks for many applicant tracking systems. - name: Unified LMS API description: Unified endpoints to access all the LMS concepts you might need. - name: AI Apply description: Endpoints for AI-powered job application features. - name: Custom Endpoints description: Custom integration-specific endpoints. paths: /hris/skill-proficiency-ratings: get: tags: - Unified HRIS API summary: Get employee skill proficiency ratings description: >- Retrieve all employee skill proficiency ratings. This feature is currently available for the following integrations: You'd like to see this feature for another integration? Please reach out! We're always happy to discuss extending our coverage. Retrieve skill proficiency ratings on employees. Each row is one rating, differentiated by `rating_source` – the same employee and skill can have several rows (e.g. a `SELF` and an `EXTERNAL` rating). Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)` operationId: GetHrisSkillProficiencyRatings parameters: - in: header name: X-Integration-Id schema: type: string description: ID of the integration you want to interact with. example: bamboohr:HWUTwvyx2wLoSUHphiWVrp28 required: true - name: cursor in: query required: false description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. schema: $ref: '#/components/schemas/GetHrisSkillProficiencyRatingsParameterCursor' - name: page_size in: query required: false description: The number of results to return per page. Maximum is 250. schema: $ref: >- #/components/schemas/GetHrisSkillProficiencyRatingsParameterPageSize - name: updated_after in: query required: false description: >- Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. | Path | Added/Removed | Linked Record | | --- | --- | --- | | `employee` | ✗ No | ✗ No | | `skill` | ✗ No | ✗ No | | `rating_provider` | ✗ No | ✗ No | _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ schema: $ref: >- #/components/schemas/GetHrisSkillProficiencyRatingsParameterUpdatedAfter - name: include_deleted in: query required: false description: >- By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. schema: $ref: >- #/components/schemas/GetHrisSkillProficiencyRatingsParameterIncludeDeleted - name: ignore_unsupported_filters in: query required: false description: >- When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. schema: $ref: >- #/components/schemas/GetHrisSkillProficiencyRatingsParameterIgnoreUnsupportedFilters - name: ids in: query required: false description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. schema: $ref: '#/components/schemas/GetHrisSkillProficiencyRatingsParameterIds' - name: remote_ids in: query required: false description: Filter by a comma-separated list of remote IDs. schema: $ref: >- #/components/schemas/GetHrisSkillProficiencyRatingsParameterRemoteIds - name: employee_ids in: query required: false description: Filter by a comma-separated list of employee IDs. schema: $ref: >- #/components/schemas/GetHrisSkillProficiencyRatingsParameterEmployeeIds - name: skill_ids in: query required: false description: Filter by a comma-separated list of skill IDs. schema: $ref: >- #/components/schemas/GetHrisSkillProficiencyRatingsParameterSkillIds responses: '200': description: GET /hris/skill-proficiency-ratings Positive response content: application/json: schema: $ref: >- #/components/schemas/GetHrisSkillProficiencyRatingsPositiveResponse examples: example1: value: status: success data: next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - id: 8AvRLpxwY5J6pGxfY6fUD81Z remote_id: 238476582-99123 employee_id: 26vafvWSRmbhNcxJYqjCzuJg skill_id: 28KMdr68N8kG9EzLwjsN9aoz proficiency: selected_option_id: 3aKMdr68N8kG9EzLwjsN4 type: SINGLE_SELECT changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null remote_data: null custom_fields: null integration_fields: [] employee: id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe display_full_name: John Doe work_email: john.doe@acme.com remote_deleted_at: null skill: id: 28KMdr68N8kG9EzLwjsN9aoz remote_id: '238476582' name: TypeScript Programming proficiency_scale: id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert rating_source: EXTERNAL rating_provider_id: 7xPdr68N8kG9EzLwjsN9xyz rating_provider: id: 7xPdr68N8kG9EzLwjsN9xyz remote_id: provider-12345 name: Acme Skill Assessments default: $ref: '#/components/responses/ErrorResponseHRIS' components: schemas: GetHrisSkillProficiencyRatingsParameterCursor: type: string description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. GetHrisSkillProficiencyRatingsParameterPageSize: type: integer format: int64 minimum: 1 maximum: 250 default: 100 description: The number of results to return per page. Maximum is 250. GetHrisSkillProficiencyRatingsParameterUpdatedAfter: description: >- Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. | Path | Added/Removed | Linked Record | | --- | --- | --- | | `employee` | ✗ No | ✗ No | | `skill` | ✗ No | ✗ No | | `rating_provider` | ✗ No | ✗ No | _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ type: string format: date-time pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString GetHrisSkillProficiencyRatingsParameterIncludeDeleted: type: string enum: - 'true' - 'false' default: 'false' description: >- By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. GetHrisSkillProficiencyRatingsParameterIgnoreUnsupportedFilters: type: string enum: - 'true' - 'false' default: 'false' description: >- When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. GetHrisSkillProficiencyRatingsParameterIds: type: string description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. GetHrisSkillProficiencyRatingsParameterRemoteIds: type: string description: Filter by a comma-separated list of remote IDs. GetHrisSkillProficiencyRatingsParameterEmployeeIds: type: string description: Filter by a comma-separated list of employee IDs. GetHrisSkillProficiencyRatingsParameterSkillIds: type: string description: Filter by a comma-separated list of skill IDs. GetHrisSkillProficiencyRatingsPositiveResponse: 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: discriminator: propertyName: rating_source anyOf: - 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. employee_id: type: string description: >- The Kombo ID of the employee. Can be used to retrieve the employee from the `get employees` endpoint. skill_id: type: string description: >- The Kombo ID of the skill. Can be used to retrieve the skill from the `get skills` endpoint. proficiency: discriminator: propertyName: type anyOf: - type: object properties: type: type: string const: NUMERIC value: type: number format: double description: The numeric proficiency value on the scale. required: - type - value - type: object properties: type: type: string const: SINGLE_SELECT selected_option_id: type: string description: >- The Kombo ID of the selected option on the scale (`proficiency_scale.ordered_options[].id`). required: - type - selected_option_id - type: 'null' description: >- The selected value on the scale. `null` when the skill is assigned to the employee but not rated. The scale itself lives on the skill. 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 remote_data: type: - object - 'null' additionalProperties: true description: >- Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it. 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. - `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 employee: 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. first_name: type: - string - 'null' description: The employee’s first name. last_name: type: - string - 'null' description: The employee’s last name. display_full_name: type: - string - 'null' description: >- The employee’s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to `first_name` and `last_name`. work_email: type: - string - 'null' pattern: >- ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$ description: >- The employee’s work email address. If the email address is invalid, we will set this to `null`. 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 required: - id - remote_id - first_name - last_name - display_full_name - remote_deleted_at description: The employee this rating belongs to. examples: - id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe display_full_name: John Doe work_email: john.doe@acme.com remote_deleted_at: null skill: 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 skill, in the default locale of the remote system. proficiency_scale: discriminator: propertyName: type anyOf: - 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. type: type: string const: NUMERIC min: type: - number - 'null' format: double description: The lowest value of the proficiency scale. max: type: - number - 'null' format: double description: >- The highest value of the proficiency scale. step: type: - number - 'null' format: double description: >- The increment between valid values – `1` for an integer scale, a fractional value (e.g. `0.1`) for finer scales, `null` for a continuous scale with no fixed step. required: - id - remote_id - type - min - max - step - 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. type: type: string const: SINGLE_SELECT ordered_options: type: array items: type: object properties: id: type: string description: >- The Kombo ID of this proficiency option. Submit this ID when writing a rating for a `SINGLE_SELECT` skill. remote_id: type: - string - 'null' description: >- The ID of this option in the remote system. `null` when the system identifies the level only by its name. name: type: string description: >- The display name of this proficiency level. required: - id - remote_id - name description: >- The available proficiency levels, ordered from lowest to highest. required: - id - remote_id - type - ordered_options - type: 'null' examples: - id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert description: >- The scale used to rate this skill, useful when writing a rating back. `null` when the skill has no scale. required: - id - remote_id - name - proficiency_scale description: The skill this rating is for. examples: - id: 28KMdr68N8kG9EzLwjsN9aoz remote_id: '238476582' name: TypeScript Programming proficiency_scale: id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert rating_source: type: string const: EXTERNAL description: >- Marks this as an externally-produced rating (e.g. from an assessment, labor-market enrichment, or inference engine). Carries `rating_provider_id` / `rating_provider` identifying the external provider that produced it. rating_provider_id: type: - string - 'null' description: >- The Kombo ID of the external provider that produced the rating. `null` when the source is `EXTERNAL` but no provider was recorded. rating_provider: type: - object - 'null' 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 provider. required: - id - remote_id - name examples: - id: 7xPdr68N8kG9EzLwjsN9xyz remote_id: provider-12345 name: Acme Skill Assessments description: >- The external provider that produced the rating, embedded from `rating_provider_id`. `null` when no provider was recorded. required: - id - remote_id - employee_id - skill_id - changed_at - remote_deleted_at - remote_data - custom_fields - integration_fields - employee - skill - rating_source - rating_provider_id - rating_provider - 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. employee_id: type: string description: >- The Kombo ID of the employee. Can be used to retrieve the employee from the `get employees` endpoint. skill_id: type: string description: >- The Kombo ID of the skill. Can be used to retrieve the skill from the `get skills` endpoint. proficiency: discriminator: propertyName: type anyOf: - type: object properties: type: type: string const: NUMERIC value: type: number format: double description: The numeric proficiency value on the scale. required: - type - value - type: object properties: type: type: string const: SINGLE_SELECT selected_option_id: type: string description: >- The Kombo ID of the selected option on the scale (`proficiency_scale.ordered_options[].id`). required: - type - selected_option_id - type: 'null' description: >- The selected value on the scale. `null` when the skill is assigned to the employee but not rated. The scale itself lives on the skill. 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 remote_data: type: - object - 'null' additionalProperties: true description: >- Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it. 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. - `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 employee: 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. first_name: type: - string - 'null' description: The employee’s first name. last_name: type: - string - 'null' description: The employee’s last name. display_full_name: type: - string - 'null' description: >- The employee’s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to `first_name` and `last_name`. work_email: type: - string - 'null' pattern: >- ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$ description: >- The employee’s work email address. If the email address is invalid, we will set this to `null`. 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 required: - id - remote_id - first_name - last_name - display_full_name - remote_deleted_at description: The employee this rating belongs to. examples: - id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe display_full_name: John Doe work_email: john.doe@acme.com remote_deleted_at: null skill: 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 skill, in the default locale of the remote system. proficiency_scale: discriminator: propertyName: type anyOf: - 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. type: type: string const: NUMERIC min: type: - number - 'null' format: double description: The lowest value of the proficiency scale. max: type: - number - 'null' format: double description: >- The highest value of the proficiency scale. step: type: - number - 'null' format: double description: >- The increment between valid values – `1` for an integer scale, a fractional value (e.g. `0.1`) for finer scales, `null` for a continuous scale with no fixed step. required: - id - remote_id - type - min - max - step - 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. type: type: string const: SINGLE_SELECT ordered_options: type: array items: type: object properties: id: type: string description: >- The Kombo ID of this proficiency option. Submit this ID when writing a rating for a `SINGLE_SELECT` skill. remote_id: type: - string - 'null' description: >- The ID of this option in the remote system. `null` when the system identifies the level only by its name. name: type: string description: >- The display name of this proficiency level. required: - id - remote_id - name description: >- The available proficiency levels, ordered from lowest to highest. required: - id - remote_id - type - ordered_options - type: 'null' examples: - id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert description: >- The scale used to rate this skill, useful when writing a rating back. `null` when the skill has no scale. required: - id - remote_id - name - proficiency_scale description: The skill this rating is for. examples: - id: 28KMdr68N8kG9EzLwjsN9aoz remote_id: '238476582' name: TypeScript Programming proficiency_scale: id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert rating_source: type: string const: SELF description: Marks this as a self-assessed rating by the employee. required: - id - remote_id - employee_id - skill_id - changed_at - remote_deleted_at - remote_data - custom_fields - integration_fields - employee - skill - rating_source - 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. employee_id: type: string description: >- The Kombo ID of the employee. Can be used to retrieve the employee from the `get employees` endpoint. skill_id: type: string description: >- The Kombo ID of the skill. Can be used to retrieve the skill from the `get skills` endpoint. proficiency: discriminator: propertyName: type anyOf: - type: object properties: type: type: string const: NUMERIC value: type: number format: double description: The numeric proficiency value on the scale. required: - type - value - type: object properties: type: type: string const: SINGLE_SELECT selected_option_id: type: string description: >- The Kombo ID of the selected option on the scale (`proficiency_scale.ordered_options[].id`). required: - type - selected_option_id - type: 'null' description: >- The selected value on the scale. `null` when the skill is assigned to the employee but not rated. The scale itself lives on the skill. 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 remote_data: type: - object - 'null' additionalProperties: true description: >- Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it. 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. - `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 employee: 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. first_name: type: - string - 'null' description: The employee’s first name. last_name: type: - string - 'null' description: The employee’s last name. display_full_name: type: - string - 'null' description: >- The employee’s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to `first_name` and `last_name`. work_email: type: - string - 'null' pattern: >- ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$ description: >- The employee’s work email address. If the email address is invalid, we will set this to `null`. 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 required: - id - remote_id - first_name - last_name - display_full_name - remote_deleted_at description: The employee this rating belongs to. examples: - id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe display_full_name: John Doe work_email: john.doe@acme.com remote_deleted_at: null skill: 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 skill, in the default locale of the remote system. proficiency_scale: discriminator: propertyName: type anyOf: - 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. type: type: string const: NUMERIC min: type: - number - 'null' format: double description: The lowest value of the proficiency scale. max: type: - number - 'null' format: double description: >- The highest value of the proficiency scale. step: type: - number - 'null' format: double description: >- The increment between valid values – `1` for an integer scale, a fractional value (e.g. `0.1`) for finer scales, `null` for a continuous scale with no fixed step. required: - id - remote_id - type - min - max - step - 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. type: type: string const: SINGLE_SELECT ordered_options: type: array items: type: object properties: id: type: string description: >- The Kombo ID of this proficiency option. Submit this ID when writing a rating for a `SINGLE_SELECT` skill. remote_id: type: - string - 'null' description: >- The ID of this option in the remote system. `null` when the system identifies the level only by its name. name: type: string description: >- The display name of this proficiency level. required: - id - remote_id - name description: >- The available proficiency levels, ordered from lowest to highest. required: - id - remote_id - type - ordered_options - type: 'null' examples: - id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert description: >- The scale used to rate this skill, useful when writing a rating back. `null` when the skill has no scale. required: - id - remote_id - name - proficiency_scale description: The skill this rating is for. examples: - id: 28KMdr68N8kG9EzLwjsN9aoz remote_id: '238476582' name: TypeScript Programming proficiency_scale: id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert rating_source: type: string const: MANAGER description: >- Marks this as a rating assessed by the employee’s manager. required: - id - remote_id - employee_id - skill_id - changed_at - remote_deleted_at - remote_data - custom_fields - integration_fields - employee - skill - rating_source - 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. employee_id: type: string description: >- The Kombo ID of the employee. Can be used to retrieve the employee from the `get employees` endpoint. skill_id: type: string description: >- The Kombo ID of the skill. Can be used to retrieve the skill from the `get skills` endpoint. proficiency: discriminator: propertyName: type anyOf: - type: object properties: type: type: string const: NUMERIC value: type: number format: double description: The numeric proficiency value on the scale. required: - type - value - type: object properties: type: type: string const: SINGLE_SELECT selected_option_id: type: string description: >- The Kombo ID of the selected option on the scale (`proficiency_scale.ordered_options[].id`). required: - type - selected_option_id - type: 'null' description: >- The selected value on the scale. `null` when the skill is assigned to the employee but not rated. The scale itself lives on the skill. 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 remote_data: type: - object - 'null' additionalProperties: true description: >- Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it. 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. - `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 employee: 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. first_name: type: - string - 'null' description: The employee’s first name. last_name: type: - string - 'null' description: The employee’s last name. display_full_name: type: - string - 'null' description: >- The employee’s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to `first_name` and `last_name`. work_email: type: - string - 'null' pattern: >- ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$ description: >- The employee’s work email address. If the email address is invalid, we will set this to `null`. 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 required: - id - remote_id - first_name - last_name - display_full_name - remote_deleted_at description: The employee this rating belongs to. examples: - id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe display_full_name: John Doe work_email: john.doe@acme.com remote_deleted_at: null skill: 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 skill, in the default locale of the remote system. proficiency_scale: discriminator: propertyName: type anyOf: - 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. type: type: string const: NUMERIC min: type: - number - 'null' format: double description: The lowest value of the proficiency scale. max: type: - number - 'null' format: double description: >- The highest value of the proficiency scale. step: type: - number - 'null' format: double description: >- The increment between valid values – `1` for an integer scale, a fractional value (e.g. `0.1`) for finer scales, `null` for a continuous scale with no fixed step. required: - id - remote_id - type - min - max - step - 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. type: type: string const: SINGLE_SELECT ordered_options: type: array items: type: object properties: id: type: string description: >- The Kombo ID of this proficiency option. Submit this ID when writing a rating for a `SINGLE_SELECT` skill. remote_id: type: - string - 'null' description: >- The ID of this option in the remote system. `null` when the system identifies the level only by its name. name: type: string description: >- The display name of this proficiency level. required: - id - remote_id - name description: >- The available proficiency levels, ordered from lowest to highest. required: - id - remote_id - type - ordered_options - type: 'null' examples: - id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert description: >- The scale used to rate this skill, useful when writing a rating back. `null` when the skill has no scale. required: - id - remote_id - name - proficiency_scale description: The skill this rating is for. examples: - id: 28KMdr68N8kG9EzLwjsN9aoz remote_id: '238476582' name: TypeScript Programming proficiency_scale: id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert rating_source: type: string const: EXPECTED description: >- Marks this as the level expected of the employee for this skill. required: - id - remote_id - employee_id - skill_id - changed_at - remote_deleted_at - remote_data - custom_fields - integration_fields - employee - skill - rating_source - 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. employee_id: type: string description: >- The Kombo ID of the employee. Can be used to retrieve the employee from the `get employees` endpoint. skill_id: type: string description: >- The Kombo ID of the skill. Can be used to retrieve the skill from the `get skills` endpoint. proficiency: discriminator: propertyName: type anyOf: - type: object properties: type: type: string const: NUMERIC value: type: number format: double description: The numeric proficiency value on the scale. required: - type - value - type: object properties: type: type: string const: SINGLE_SELECT selected_option_id: type: string description: >- The Kombo ID of the selected option on the scale (`proficiency_scale.ordered_options[].id`). required: - type - selected_option_id - type: 'null' description: >- The selected value on the scale. `null` when the skill is assigned to the employee but not rated. The scale itself lives on the skill. 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 remote_data: type: - object - 'null' additionalProperties: true description: >- Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it. 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. - `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 employee: 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. first_name: type: - string - 'null' description: The employee’s first name. last_name: type: - string - 'null' description: The employee’s last name. display_full_name: type: - string - 'null' description: >- The employee’s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to `first_name` and `last_name`. work_email: type: - string - 'null' pattern: >- ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$ description: >- The employee’s work email address. If the email address is invalid, we will set this to `null`. 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 required: - id - remote_id - first_name - last_name - display_full_name - remote_deleted_at description: The employee this rating belongs to. examples: - id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe display_full_name: John Doe work_email: john.doe@acme.com remote_deleted_at: null skill: 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 skill, in the default locale of the remote system. proficiency_scale: discriminator: propertyName: type anyOf: - 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. type: type: string const: NUMERIC min: type: - number - 'null' format: double description: The lowest value of the proficiency scale. max: type: - number - 'null' format: double description: >- The highest value of the proficiency scale. step: type: - number - 'null' format: double description: >- The increment between valid values – `1` for an integer scale, a fractional value (e.g. `0.1`) for finer scales, `null` for a continuous scale with no fixed step. required: - id - remote_id - type - min - max - step - 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. type: type: string const: SINGLE_SELECT ordered_options: type: array items: type: object properties: id: type: string description: >- The Kombo ID of this proficiency option. Submit this ID when writing a rating for a `SINGLE_SELECT` skill. remote_id: type: - string - 'null' description: >- The ID of this option in the remote system. `null` when the system identifies the level only by its name. name: type: string description: >- The display name of this proficiency level. required: - id - remote_id - name description: >- The available proficiency levels, ordered from lowest to highest. required: - id - remote_id - type - ordered_options - type: 'null' examples: - id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert description: >- The scale used to rate this skill, useful when writing a rating back. `null` when the skill has no scale. required: - id - remote_id - name - proficiency_scale description: The skill this rating is for. examples: - id: 28KMdr68N8kG9EzLwjsN9aoz remote_id: '238476582' name: TypeScript Programming proficiency_scale: id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert rating_source: type: 'null' description: The rating source is not known for this row. required: - id - remote_id - employee_id - skill_id - changed_at - remote_deleted_at - remote_data - custom_fields - integration_fields - employee - skill - rating_source examples: - id: 8AvRLpxwY5J6pGxfY6fUD81Z remote_id: 238476582-99123 employee_id: 26vafvWSRmbhNcxJYqjCzuJg skill_id: 28KMdr68N8kG9EzLwjsN9aoz proficiency: selected_option_id: 3aKMdr68N8kG9EzLwjsN4 type: SINGLE_SELECT changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null remote_data: null custom_fields: null integration_fields: [] employee: id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe display_full_name: John Doe work_email: john.doe@acme.com remote_deleted_at: null skill: id: 28KMdr68N8kG9EzLwjsN9aoz remote_id: '238476582' name: TypeScript Programming proficiency_scale: id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert rating_source: EXTERNAL rating_provider_id: 7xPdr68N8kG9EzLwjsN9xyz rating_provider: id: 7xPdr68N8kG9EzLwjsN9xyz remote_id: provider-12345 name: Acme Skill Assessments required: - next - results examples: - next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - id: 8AvRLpxwY5J6pGxfY6fUD81Z remote_id: 238476582-99123 employee_id: 26vafvWSRmbhNcxJYqjCzuJg skill_id: 28KMdr68N8kG9EzLwjsN9aoz proficiency: selected_option_id: 3aKMdr68N8kG9EzLwjsN4 type: SINGLE_SELECT changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null remote_data: null custom_fields: null integration_fields: [] employee: id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe display_full_name: John Doe work_email: john.doe@acme.com remote_deleted_at: null skill: id: 28KMdr68N8kG9EzLwjsN9aoz remote_id: '238476582' name: TypeScript Programming proficiency_scale: id: 5xKMdr68N8kG9EzLwjsN9scl remote_id: scale-12345 type: SINGLE_SELECT ordered_options: - id: 3aKMdr68N8kG9EzLwjsN1 remote_id: '1' name: Beginner - id: 3aKMdr68N8kG9EzLwjsN2 remote_id: '2' name: Intermediate - id: 3aKMdr68N8kG9EzLwjsN3 remote_id: '3' name: Advanced - id: 3aKMdr68N8kG9EzLwjsN4 remote_id: '4' name: Expert rating_source: EXTERNAL rating_provider_id: 7xPdr68N8kG9EzLwjsN9xyz rating_provider: id: 7xPdr68N8kG9EzLwjsN9xyz remote_id: provider-12345 name: Acme Skill Assessments required: - status - data responses: ErrorResponseHRIS: description: The standard error response with the error codes for the HRIS use case. content: application/json: schema: type: object properties: status: type: string enum: - error error: type: object properties: code: type: - string - 'null' enum: - PLATFORM.RATE_LIMIT_EXCEEDED - PLATFORM.CONCURRENCY_LIMIT_EXCEEDED - PLATFORM.INTEGRATION_NOT_FOUND - PLATFORM.INPUT_INVALID - PLATFORM.UNKNOWN_ERROR - PLATFORM.IP_NOT_WHITELISTED - PLATFORM.AUTHENTICATION_INVALID - PLATFORM.TASK_TIMED_OUT - INTEGRATION.PERMISSION_MISSING - INTEGRATION.AUTHENTICATION_INVALID - INTEGRATION.QA_FAILED - INTEGRATION.SETUP_SYNC_PENDING - INTEGRATION.SETUP_INCOMPLETE - INTEGRATION.INACTIVE - INTEGRATION.MODEL_NOT_AVAILABLE - INTEGRATION.MODEL_DISABLED - INTEGRATION.ACTION_NOT_AVAILABLE - INTEGRATION.ACTION_DISABLED - REMOTE.SERVICE_UNAVAILABLE - REMOTE.RATE_LIMIT_EXCEEDED - REMOTE.INPUT_INVALID - REMOTE.UNKNOWN_HTTP_ERROR - HRIS.STAFFING_ENTITY_CLOSED - HRIS.EMPLOYEE_ALREADY_EXISTS example: HRIS.EMPLOYEE_ALREADY_EXISTS description: >- Some errors include an error code that can be used to identify their cause. See the [Error Handling Docs](https://docs.kombo.dev/guides/errors) for more information. For your error handling logic please use the error `code` instead of other properties (e.g. message, http status code, ...). title: type: - string - 'null' description: A static, human-readable label. message: type: string description: >- A dynamic, detailed description of what went wrong in this specific instance. log_url: type: - string - 'null' format: uri description: >- The log page in the Kombo UI lists every interaction with full details. If you need assistance, share that link with our support team. required: - code - title - message - log_url description: Error details with structured code for programmatic handling. required: - status - error examples: Error Response: description: >- When building error handling logic, always use the `code` field to identify specific error types programmatically. See the complete list of error codes in the [docs](https://docs.kombo.dev/guides/errors). value: status: error error: code: INTEGRATION.MODEL_NOT_AVAILABLE title: >- This data model isn't supported for the selected integration. message: >- The "employees" model is not yet available for Greenhouse. Please reach out to Kombo if you need this functionality. log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456 Minimal Error Response: description: >- The "message" is always required while other fields can also be `null`. See the [docs](https://docs.kombo.dev/guides/errors) for more information. value: status: error error: code: null title: null message: The message is always in the response. log_url: null securitySchemes: ApiKey: type: http scheme: bearer description: >- Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard. ````