BIbindbee
Skills

Get Skill By Id

Changed on

Returns a Skill object with the given id.

get/api/hris/v1/skills/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

namestring nullable required

Human-readable name of the skill.

descriptionstring nullable required

A detailed description of the skill.

categorystring nullable required

The category this skill belongs to, such as a department or competency group.

statusstring nullable required

The status of the skill. If the value is not one of the defined enum values, the original value passed through will be returned.

proficiency_scaleobject nullable required

The scale used to measure proficiency in this skill. Shape depends on the embedded 'type' key: when 'type' is 'NUMERIC', the object also carries 'min', 'max', and 'step'; when 'type' is 'SINGLE_SELECT', the object carries 'options', a flat list of the allowed proficiency labels.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "name": "Employee Relations",
  "description": "Maintain good relations with Employees",
  "category": "Human Resources",
  "status": "ACTIVE",
  "proficiency_scale": {
    "max": 5,
    "min": 1,
    "step": 0.5,
    "type": "NUMERIC"
  }
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the ACTIVE enum value from the response property for the response status

    • info

      removed the INACTIVE enum value from the response property for the response status

  • 4695175eeff0Revision changes
    • info

      endpoint added