API - Talents

Talents

This endpoint manages talent profiles within the organization’s talent management system.

Overview

The Talents API provides functionality for creating and managing comprehensive talent profiles. These profiles serve as the foundation for skills management, career development, and talent matching within the organization.

Key Features

Data Synchronization

This endpoint synchronizes with the IAM People service to maintain consistent personal information across systems. Core identity data (names, organizational unit, profile picture) is automatically kept in sync with the central IAM records.

Endpoints

get/api/v3/talent/talents

Return a paginated list of talent/talents

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
organizational_unit?: unknown
first_name?: unknown
middle_name?: unknown
last_name?: unknown
picture_url?: unknown
created_at?: unknown
is_favorited?: unknown
facets?: unknown
search?: unknown
favorites_only?: unknown
with_favorites?: unknown
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;
    organizational_unit?: any;
    first_name?: any;
    middle_name?: any;
    last_name?: any;
    picture_url?: any;
    created_at?: any;
    is_favorited?: any;
    facets?: any;
    search?: any;
    favorites_only?: any;
    with_favorites?: any;
  };
  // 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
organizational_unit?: string
first_name?: string
middle_name?: string
last_name?: string
picture_url?: string or null
created_at?: datetime
is_favorited?: boolean
facets?: array
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      organizational_unit?: string;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      picture_url?: string | null;
      created_at?: Date;
      is_favorited?: boolean;
      facets?: Array<any>;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/talent/talents

Create a new talent/talents

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
organizational_unit?: string
first_name?: string
middle_name?: string
last_name?: string
picture_url?: string or null
created_at?: datetime
is_favorited?: boolean
facets?: array

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      organizational_unit?: string;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      picture_url?: string | null;
      created_at?: Date;
      is_favorited?: boolean;
      facets?: Array<any>;
    };
  };
};

delete/api/v3/talent/talents/:resource_id

Delete the talent/talents

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/talent/talents/:resource_id

Show a specific talent/talents

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
organizational_unit?: string
first_name?: string
middle_name?: string
last_name?: string
picture_url?: string or null
created_at?: datetime
is_favorited?: boolean
facets?: array
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      organizational_unit?: string;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      picture_url?: string | null;
      created_at?: Date;
      is_favorited?: boolean;
      facets?: Array<any>;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/talent/talents/:resource_id

Update a talent/talents

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
organizational_unit?: string
first_name?: string
middle_name?: string
last_name?: string
facets?: array

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      organizational_unit?: string;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      facets?: Array<any>;
    };
  };
};

post/api/v3/talent/talents/upload_resume

Create a talent with a resume

Input Schema

object
file_url: string
mime_type: string
create_candidate?: boolean
organizational_unit: string

Typescript

type InputSchema = {
  file_url: string;
  mime_type: string;
  create_candidate?: boolean;
  organizational_unit: string;
};