Skip to main content
GET
Get Skill By Id

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Path Parameters

id
string<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

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

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

Response

Successful Response

The Skill object represents a skill definition, such as a competency or proficiency area, that can be assigned to employees.

id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string<date-time>
required

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

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
name
string | null
required

Human-readable name of the skill.

Example:

"Employee Relations"

description
string | null
required

A detailed description of the skill.

Example:

"Maintain good relations with Employees"

category
string | null
required

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

Example:

"Human Resources"

status
string | null
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.

Example:

"ACTIVE"

proficiency_scale
Proficiency Scale · object | null
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:
raw_data
Raw Data · object | null

This is the Raw data

Example: