kustomer-client
    Preparing search index...

    Function getConversationEvents

    • Get conversation events Retrieves a paginated list of conversation events based on the unique ID of the conversation.

      You can use the name and/or changed query parameters to filter the results.

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

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

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      changes?: {
                          attributes: {
                              modifiedAt?: { after: string; before: string; op: string };
                              updatedAt?: { after: string; before: string; op: string };
                          };
                          relationships: {
                              customer?: {
                                  after: { data: ...; links: ... };
                                  before: { data: ...; links: ... };
                                  op: string;
                              };
                          };
                      };
                      createdAt: string;
                      location: null
                      | string;
                      meta: null | string;
                      modifiedAt: string;
                      name: string;
                      publishedAt: string;
                      type: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { self: 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: { [key: string]: unknown };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility