kustomer-client
    Preparing search index...

    Function getAllForwardsByConversation

    • Get all forwards by conversation Retrieves all forwarded conversations based on the unique conversation ID.

      To learn more, see Forwarding conversations in the Kustomer Help Center.

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

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

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      app: string;
                      body: string;
                      channel: string;
                      createdAt: string;
                      from: { email: string; name: string };
                      modifiedAt: string;
                      payload?: {
                          draftJs: {
                              blocks: {
                                  data: { [key: ...]: ... };
                                  depth: number;
                                  entityRanges: (...)[];
                                  inlineStyleRanges: (...)[];
                                  key: string;
                                  text: string;
                                  type: string;
                              }[];
                              entityMap: { [key: string]: unknown };
                          };
                      };
                      status: string;
                      to: { email: string; name: string }[];
                      updatedAt: string;
                  };
                  id: string;
                  relationships: {
                      conversation?: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      createdBy: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      customer: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      modifiedBy: {
                          data: { id: string; type: string };
                          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