API - Organization People Directories

Organization People Directories

No description given.

Endpoints

get/api/v3/iam/organization/people_directories

Return a paginated list of iam/organizations/people_directories

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
first_name?: unknown
middle_name?: unknown
last_name?: unknown
picture_url?: unknown
tag?: unknown
position?: unknown
contact_number?: unknown
email?: unknown
other_contacts?: unknown
project_ids?: unknown
created_at?: unknown
updated_at?: unknown
person_id?: unknown
organization_id?: unknown
organization_id?: unknown
search?: unknown
The related resources to include in the response. Allowed resources are:
- `organization`
- `person`
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;
    first_name?: any;
    middle_name?: any;
    last_name?: any;
    picture_url?: any;
    tag?: any;
    position?: any;
    contact_number?: any;
    email?: any;
    other_contacts?: any;
    project_ids?: any;
    created_at?: any;
    updated_at?: any;
    person_id?: any;
    organization_id?: any;
    organization_id?: any;
    search?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `organization`
  // - `person`
  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
first_name?: string
middle_name?: string
last_name?: string
picture_url?: string or null
tag?: string
position?: string
contact_number?: string or null
email?: string or null
other_contacts?: open struct
project_ids?: array or null
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      picture_url?: string | null;
      tag?: string;
      position?: string;
      contact_number?: string | null;
      email?: string | null;
      other_contacts?: Record<string, any>;
      project_ids?: Array<any> | null;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/iam/organization/people_directories

Create a new iam/organizations/people_directories

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
first_name?: string
middle_name?: string
last_name?: string
picture_url?: string or null
tag?: string
position?: string
contact_number?: string or null
email?: string or null
other_contacts?: open struct
project_ids?: array or null
created_at?: datetime
updated_at?: datetime
relationships?:
object
person:
object
data:
object
type: string
id?: string
organization:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      picture_url?: string | null;
      tag?: string;
      position?: string;
      contact_number?: string | null;
      email?: string | null;
      other_contacts?: Record<string, any>;
      project_ids?: Array<any> | null;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: {
      person: { data: { type: string; id?: string } };
      organization: { data: { type: string; id?: string } };
    };
  };
};

get/api/v3/iam/organization/people_directories/:id/available

Get the availability status of an employee in real-time. Will be false if the employee is on leave or on holiday or out of office. Otherwise, it will be true.

Input Schema

object
id: integer

Typescript

type InputSchema = { id: number };

delete/api/v3/iam/organization/people_directories/:resource_id

Delete the iam/organizations/people_directories

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/iam/organization/people_directories/:resource_id

Show a specific iam/organizations/people_directories

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
first_name?: string
middle_name?: string
last_name?: string
picture_url?: string or null
tag?: string
position?: string
contact_number?: string or null
email?: string or null
other_contacts?: open struct
project_ids?: array or null
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      picture_url?: string | null;
      tag?: string;
      position?: string;
      contact_number?: string | null;
      email?: string | null;
      other_contacts?: Record<string, any>;
      project_ids?: Array<any> | null;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/iam/organization/people_directories/:resource_id

Update a iam/organizations/people_directories

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
tag?: string
position?: string
other_contacts?: open struct
project_ids?: array or null
relationships?:
object
person:
object
data:
object
type: string
id?: string
organization:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      tag?: string;
      position?: string;
      other_contacts?: Record<string, any>;
      project_ids?: Array<any> | null;
    };
    relationships?: {
      person: { data: { type: string; id?: string } };
      organization: { data: { type: string; id?: string } };
    };
  };
};