kustomer-client
    Preparing search index...

    Function getMessages

    • Get messages Retrieves messages for your Kustomer organization.

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

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

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      app: string;
                      channel: string;
                      createdAt: string;
                      direction: string;
                      externalId: string;
                      meta: {
                          cc: unknown[];
                          from: string;
                          inReplyTo: string;
                          recipient: { email: string; mailboxHash: string };
                          subject: string;
                          to: { email: string }[];
                      };
                      preview: string;
                      sentAt: string;
                      sentiment: { [key: string]: unknown };
                      size: number;
                      status: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { related: string; self: string };
                  relationships: {
                      conversation: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      customer: {
                          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 };
          },
          {
              errors: {
                  code: string;
                  source: { parameters: string };
                  status: string;
                  title: string;
              }[];
          },
          ThrowOnError,
      >