kustomer-client
    Preparing search index...

    Function getNoteById

    • Get note by ID Retrieves a note based on the unique note ID.

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

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

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: { body: string; createdAt: 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 };
                      };
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility