kustomer-client
    Preparing search index...

    Function getKObject

    • Get KObject (custom object) by ID Retrieves a KObject (custom object) based on the unique KObject ID.

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

      Legacy Role Equivalent Permission Set Role
      org.user.kobject.read org.permission.kobject.read
      org.permission.kobject.kobject_*.read

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      assignedUser?: string;
                      createdAt: string;
                      custom: {
                          billingStatusStr: string;
                          orderDescriptionStr: string;
                          orderNumberNum: number;
                          orderStatusStr: string;
                          orderUpdatedAt: string;
                          shippingStatusStr: string;
                          specialInstructionsStr: string;
                          totalPriceNum: number;
                      };
                      doneCount?: number;
                      firstDone?: {
                          assignedTeam?: string;
                          assignedUser?: string;
                          businessTime?: number;
                          commentCount?: number;
                          createdAt?: string;
                          createdBy?: string;
                          createdByTeam?: string;
                          time?: number;
                      };
                      icon: string;
                      images: string[];
                      lastDone?: {
                          assignedTeam?: string;
                          assignedUser?: string;
                          businessTime?: number;
                          commentCount?: number;
                          createdAt?: string;
                          createdBy?: string;
                          createdByTeam?: string;
                          time?: number;
                      };
                      queue?: string;
                      reopenCount?: number;
                      reopenFromDoneCount?: number;
                      rev: number;
                      status?: "open"
                      | "done";
                      tags: unknown[];
                      title: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      klass: { data: { id: string; type: string }; link: { self: string } };
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility