API - Notes

Notes

This endpoint manages notes and feedback related to candidates in the recruitment process.

Overview

The Notes API allows recruiters, interviewers, and hiring managers to record observations, feedback, and evaluations about candidates throughout the recruitment process. These notes provide valuable context for hiring decisions and candidate assessment.

Key Features

Note Types

Notes can include various types of information:

Relationships

Each note must be associated with a specific candidate. When creating a new note, you must specify the candidate it relates to using the relationship field.

Endpoints

get/api/v3/recruitment/notes

Return a paginated list of recruitment/notes

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
created_at?: unknown
updated_at?: unknown
candidate_id?: unknown
author_id?: unknown
content?: unknown
candidate_id?: unknown
The related resources to include in the response. Allowed resources are:
- `candidate`
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;
    created_at?: any;
    updated_at?: any;
    candidate_id?: any;
    author_id?: any;
    content?: any;
    candidate_id?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `candidate`
  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
created_at?: datetime
updated_at?: datetime
author_id?: integer
content?: string
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      created_at?: Date;
      updated_at?: Date;
      author_id?: number;
      content?: string;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/recruitment/notes

Create a new recruitment/notes

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
created_at?: datetime
updated_at?: datetime
author_id?: integer
content?: string
relationships?:
object
candidate:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      created_at?: Date;
      updated_at?: Date;
      author_id?: number;
      content?: string;
    };
    relationships?: { candidate: { data: { type: string; id?: string } } };
  };
};

delete/api/v3/recruitment/notes/:resource_id

Delete the recruitment/notes

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

patch/api/v3/recruitment/notes/:resource_id

Update a recruitment/notes

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
created_at?: datetime
updated_at?: datetime
author_id?: integer
content?: string

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      created_at?: Date;
      updated_at?: Date;
      author_id?: number;
      content?: string;
    };
  };
};