Clients

The clients resource manages client records in the system, providing flexible options to retrieve, create and update client information.

Endpoints

get /api/v3/client/clients get /api/v3/client/clients/:resource_id

get/api/v3/client/clients

Return a paginated list of client/clients

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
person_id?: unknown
organizational_unit?: unknown
organization_ids?: unknown
superset_user_id?: unknown
enabled?: unknown
email?: unknown
first_name?: unknown
middle_name?: unknown
last_name?: unknown
picture_url?: 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;
    person_id?: any;
    organizational_unit?: any;
    organization_ids?: any;
    superset_user_id?: any;
    enabled?: any;
    email?: any;
    first_name?: any;
    middle_name?: any;
    last_name?: any;
    picture_url?: 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
person_id?: integer
organizational_unit?: string
organization_ids?: array
superset_user_id?: integer
enabled?: boolean
email?: string
first_name?: string
middle_name?: string or null
last_name?: string
picture_url?: string or null
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      person_id?: number;
      organizational_unit?: string;
      organization_ids?: Array<any>;
      superset_user_id?: number;
      enabled?: boolean;
      email?: string;
      first_name?: string;
      middle_name?: string | null;
      last_name?: string;
      picture_url?: string | null;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

get/api/v3/client/clients/:resource_id

Show a specific client/clients

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
person_id?: integer
organizational_unit?: string
organization_ids?: array
superset_user_id?: integer
enabled?: boolean
email?: string
first_name?: string
middle_name?: string or null
last_name?: string
picture_url?: string or null
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      person_id?: number;
      organizational_unit?: string;
      organization_ids?: Array<any>;
      superset_user_id?: number;
      enabled?: boolean;
      email?: string;
      first_name?: string;
      middle_name?: string | null;
      last_name?: string;
      picture_url?: string | null;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};