v3

OpenAPI 3.1.02026-07-311255771.3 MB

Unified HRIS API

Get employee skill proficiency ratings

Retrieve all employee skill proficiency ratings.

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)

get/hris/skill-proficiency-ratings

Query parameters

cursorstring

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_sizeinteger

The number of results to return per page. Maximum is 250.

updated_afterstring date-time

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.

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.

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.

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.

include_deleted'true' | 'false'

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

ignore_unsupported_filters'true' | 'false'

When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.

idsstring

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.

remote_idsstring

Filter by a comma-separated list of remote IDs.

employee_idsstring

Filter by a comma-separated list of employee IDs.

skill_idsstring

Filter by a comma-separated list of skill IDs.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Response

GET /hris/skill-proficiency-ratings Positive response

status'success' required

Example response

{
  "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"
        }
      }
    ]
  }
}