kustomer-client
    Preparing search index...

    Function getKlass

    • Get Klass by ID Retrieves a Klass based on the unique Klass ID.

      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;
                      color?: string;
                      createdAt: string;
                      displayName?: string;
                      icon: string;
                      mixins?: ("assignable" | "commentable" | "editable" | "creatable")[];
                      name: 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;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility