API - Skills

Skills

This endpoint manages skills associated with talent profiles.

Overview

The Skills API allows you to create, update, and manage skills that are linked to talent profiles. Skills represent specific competencies, technical abilities, or knowledge areas that talents possess, and are a key component of talent matching and development.

Skill Management

Skills in the system can include:

Key Features

Relationships

Each skill record is associated with a specific talent profile. When creating a new skill, you must specify the talent it belongs to using the relationship field.

Endpoints

get/api/v3/talent/skills

Return a paginated list of talent/skills

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
talent_id?: unknown
name?: unknown
level?: unknown
The related resources to include in the response. Allowed resources are:
- `talent`
included?:
array
Elements: string
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: { id?: any; talent_id?: any; name?: any; level?: any };
  // The related resources to include in the response. Allowed resources are:
  // - `talent`
  included?: Array<string>;
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
name?: string
level?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: { id?: number; name?: string; level?: number };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/talent/skills

Create a new talent/skills

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
name?: string
level?: integer
relationships?:
object
talent:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: { id?: number; name?: string; level?: number };
    relationships?: { talent: { data: { type: string; id?: string } } };
  };
};

delete/api/v3/talent/skills/:resource_id

Delete the talent/skills

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/talent/skills/:resource_id

Show a specific talent/skills

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
name?: string
level?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: { id?: number; name?: string; level?: number };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/talent/skills/:resource_id

Update a talent/skills

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
name?: string
level?: integer

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: { id?: number; name?: string; level?: number };
  };
};