API - People

People

The people resource manages records for individuals in the system.

Based on your role and permissions, you will get access to different sets of people.

Endpoints

get/api/v3/iam/people

Return a paginated list of iam/people

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
gender?: unknown
relationship_status?: unknown
organizational_unit?: unknown
birthday?: unknown
secondary_email?: unknown
contact_number?: unknown
physical_address?: unknown
number_of_kids?: unknown
father_name?: unknown
mother_name?: unknown
spouse_name?: unknown
place_of_birth?: unknown
created_at?: unknown
updated_at?: unknown
facets?: unknown
id__in?: unknown
first_name__match?: unknown
last_name__match?: unknown
email__match?: unknown
secondary_email__match?: unknown
contact_number__match?: unknown
enabled?: unknown
search?: unknown
facets__contains?: unknown
The related resources to include in the response. Allowed resources are:
- `account`
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;
    gender?: any;
    relationship_status?: any;
    organizational_unit?: any;
    birthday?: any;
    secondary_email?: any;
    contact_number?: any;
    physical_address?: any;
    number_of_kids?: any;
    father_name?: any;
    mother_name?: any;
    spouse_name?: any;
    place_of_birth?: any;
    created_at?: any;
    updated_at?: any;
    facets?: any;
    id__in?: any;
    first_name__match?: any;
    last_name__match?: any;
    email__match?: any;
    secondary_email__match?: any;
    contact_number__match?: any;
    enabled?: any;
    search?: any;
    facets__contains?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `account`
  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
gender?: string or null
relationship_status?: string or null
organizational_unit?: string
birthday?: date or null
secondary_email?: string or null
contact_number?: string or null
physical_address?: string or null
number_of_kids?: integer or null
father_name?: string or null
mother_name?: string or null
spouse_name?: string or null
place_of_birth?: string or null
created_at?: datetime
updated_at?: datetime
facets?: array
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;
      gender?: string | null;
      relationship_status?: string | null;
      organizational_unit?: string;
      birthday?: Date | null;
      secondary_email?: string | null;
      contact_number?: string | null;
      physical_address?: string | null;
      number_of_kids?: number | null;
      father_name?: string | null;
      mother_name?: string | null;
      spouse_name?: string | null;
      place_of_birth?: string | null;
      created_at?: Date;
      updated_at?: Date;
      facets?: Array<any>;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/iam/people

Create a new iam/people

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
gender?: string or null
relationship_status?: string or null
organizational_unit?: string
birthday?: date or null
secondary_email?: string or null
contact_number?: string or null
physical_address?: string or null
number_of_kids?: integer or null
father_name?: string or null
mother_name?: string or null
spouse_name?: string or null
place_of_birth?: string or null
created_at?: datetime
updated_at?: datetime
facets?: array

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      picture_url?: string | null;
      gender?: string | null;
      relationship_status?: string | null;
      organizational_unit?: string;
      birthday?: Date | null;
      secondary_email?: string | null;
      contact_number?: string | null;
      physical_address?: string | null;
      number_of_kids?: number | null;
      father_name?: string | null;
      mother_name?: string | null;
      spouse_name?: string | null;
      place_of_birth?: string | null;
      created_at?: Date;
      updated_at?: Date;
      facets?: Array<any>;
    };
  };
};

delete/api/v3/iam/people/:resource_id

Delete the iam/people

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/iam/people/:resource_id

Show a specific iam/people

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
gender?: string or null
relationship_status?: string or null
organizational_unit?: string
birthday?: date or null
secondary_email?: string or null
contact_number?: string or null
physical_address?: string or null
number_of_kids?: integer or null
father_name?: string or null
mother_name?: string or null
spouse_name?: string or null
place_of_birth?: string or null
created_at?: datetime
updated_at?: datetime
facets?: array
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;
      gender?: string | null;
      relationship_status?: string | null;
      organizational_unit?: string;
      birthday?: Date | null;
      secondary_email?: string | null;
      contact_number?: string | null;
      physical_address?: string | null;
      number_of_kids?: number | null;
      father_name?: string | null;
      mother_name?: string | null;
      spouse_name?: string | null;
      place_of_birth?: string | null;
      created_at?: Date;
      updated_at?: Date;
      facets?: Array<any>;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/iam/people/:resource_id

Update a iam/people

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
first_name?: string
middle_name?: string
last_name?: string
picture_url?: string or null
gender?: string or null
relationship_status?: string or null
organizational_unit?: string
birthday?: date or null
secondary_email?: string or null
contact_number?: string or null
physical_address?: string or null
number_of_kids?: integer or null
father_name?: string or null
mother_name?: string or null
spouse_name?: string or null
place_of_birth?: string or null
facets?: array

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      first_name?: string;
      middle_name?: string;
      last_name?: string;
      picture_url?: string | null;
      gender?: string | null;
      relationship_status?: string | null;
      organizational_unit?: string;
      birthday?: Date | null;
      secondary_email?: string | null;
      contact_number?: string | null;
      physical_address?: string | null;
      number_of_kids?: number | null;
      father_name?: string | null;
      mother_name?: string | null;
      spouse_name?: string | null;
      place_of_birth?: string | null;
      facets?: Array<any>;
    };
  };
};