kustomer-client
    Preparing search index...

    Function getSatisfaction

    • Get Satisfactions Retrieves a paginated list of satisfaction forms for the organization.

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

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

      Type Parameters

      • ThrowOnError extends boolean = true

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      allQuestions?: unknown[];
                      channel?: string;
                      createdAt?: string;
                      criteria?: { and?: unknown[]; or?: unknown[] };
                      delayTime?: number;
                      description?: string;
                      enabled?: boolean;
                      followUpType?: string;
                      formType?: string;
                      from?: { account?: string; app?: string; channel?: string };
                      introduction?: string;
                      metaDescription?: string;
                      metaTitle?: string;
                      modifiedAt?: string;
                      name?: string;
                      negativeQuestions?: unknown[];
                      positiveQuestions?: unknown[];
                      questions?: unknown[];
                      ratingPrompt?: string;
                      scale?: {
                          labelHigh?: string;
                          labelLow?: string;
                          options?: number;
                          type?: string;
                      };
                      updatedAt?: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      createdBy: {
                          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 } };
                      template?: {
                          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,
      >