kustomer-client
    Preparing search index...

    Function getConversation

    • Get conversation by ID Retrieves a single conversation based on the unique conversation ID.

      You can also retrieve multiple conversations with a comma-separated list of IDs.

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

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

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      assignedTeams: unknown[];
                      assignedUsers: unknown[];
                      channels: unknown[];
                      createdAt: string;
                      direction: string;
                      firstResponse: { [key: string]: unknown };
                      lastMessageIn: { [key: string]: unknown };
                      messageCount: number;
                      modifiedAt: string;
                      name: string;
                      noteCount: number;
                      outboundMessageCount: number;
                      rev: number;
                      satisfaction: number;
                      sentiment: { [key: string]: unknown };
                      status: string;
                      suggestedTags: unknown[];
                      tags: unknown[];
                      updatedAt: string;
                      [key: string]: unknown;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      createdBy: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      customer: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      messages: { links: { self: string } };
                      modifiedBy: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          GetConversationError,
          ThrowOnError,
      >

    Settings

    Member Visibility