kustomer-client
    Preparing search index...

    Function findCompanyKObjects

    • Find company KObjects (custom Objects) Retrieves all KObjects (custom Objects) that are linked to a company based on the unique company ID and unique Klass name.

      Any one of the following roles is required for this endpoint:

      Legacy Role Equivalent Permission Set Role
      org.user.company.read org.permission.company.read

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      createdAt: string;
                      custom: { [key: string]: unknown };
                      icon: string;
                      images: string[];
                      rev: number;
                      s3DataUrl?: string;
                      tags: unknown[];
                      title: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      company: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      klass: { data: { id: string; type: string }; link: { self: string } };
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              }[];
              links: {
                  first: string;
                  next: null
                  | string;
                  prev: null | string;
                  self: string;
              };
              meta: { page: number; pageSize: number };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility