kustomer-client
    Preparing search index...

    Function getKlasses

    • Get Klasses Retrieves all Klasses.

      You can filter results based on the status of the Klass. Valid values are enabled, existing_only, and disabled. The default value is enabled.

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

      Legacy Role Equivalent Permission Set Role
      org.user.klass.read org.permission.klass.read
      org.admin.klass.read

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      appDisabled?: boolean;
                      appVersion?: string;
                      color?: string;
                      createdAt: string;
                      displayName: string;
                      icon?: string;
                      klassSchema?: string;
                      mixins?: ("assignable" | "commentable" | "editable" | "creatable")[];
                      name: string;
                      s3DataUrl?: string;
                      status: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      kobjects: { links: { 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

    On This Page

    Filter by status