Survey

Get a survey by ID

get

Paramètres de requête

idstringRequis

The UUID of the survey to retrieve

Paramètres d'en-tête

X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Réponses

200

The survey has been successfully retrieved.

application/json

idstringRequis

Unique identifier

createdAtstring · date-timeRequis

Creation timestamp

updatedAtstring · date-timeRequis

Last update timestamp

namestringRequis

Internal form name.

descriptionstring · nullableRequis

Internal form description.

Default: null

languageall ofRequis

Language in which the form is written. This language is used to determine the source language for machine translation.

string · enumOptionnelValeurs possibles:

enabledbooleanRequis

Determines if the form is enabled.

autoTranslatebooleanRequis

Whether to automatically translate the form.

submissionCountnumberRequis

Number of submissions recorded for this form.

publiclyAvailablebooleanRequis

Determines whether the survey can be requested publicly without specifying a tracker

solicitationThresholdnumberRequis

Determines the maximum time threshold for sending a survey. This threshold corresponds to the difference between the purchase date and the date on which it was processed for survey dispatch, in seconds. If it is exceeded, no survey will be sent.

resolicitationDelaynumberRequis

Determine the time to wait before sending a new survey to the same customer, in seconds

resolicitationModeall ofRequis

Determines the mode of resolicitation

string · enumOptionnelValeurs possibles:

preRedirectbooleanRequis

Enable/Disable redirection to external satisfaction surveys before form submission If true, preRedirectThreshold and preRedirectConfig must be set

postRedirectbooleanRequis

Enable/Disable redirection to external satisfaction surveys before after submission If true, postRedirectThreshold must be set Default false

postRedirectThresholdnumber · nullableRequis

Threshold at which to redirect the customer to the external satisfaction survey after submitting the form If 0 is set, the redirection will always be made 0 - 10

Default: null

400

Invalid input format.

401

Unauthorized

404

Survey not found.

get

/partners/survey

HTTPcURLJavaScriptPython

GET /partners/survey?id=text HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Accept: */*

{
  "id": "text",
  "createdAt": "2026-03-14T20:57:48.883Z",
  "updatedAt": "2026-03-14T20:57:48.883Z",
  "name": "text",
  "description": "text",
  "language": "af",
  "enabled": true,
  "autoTranslate": true,
  "generalStyle": {
    "fieldRadius": "SHARP",
    "buttonRadius": "SHARP",
    "zoneColor": "text",
    "starBackgroundColor": "text",
    "starBorderColor": "text",
    "cardBorderColor": "text",
    "cardBackgroundColor": "text",
    "cardBorderRadius": "SHARP",
    "font": {
      "name": "text",
      "url": "text"
    },
    "titleColor": "text",
    "subtitleColor": "text",
    "groupColor": "text",
    "textColor": "text",
    "accentColor": "text",
    "dividerColor": "text",
    "backgroundColor": "text",
    "labelColor": "text",
    "placeholderColor": "text",
    "fieldBackgroundColor": "text",
    "fieldBorderColor": "text",
    "buttonTextColor": "text",
    "buttonBackgroundColor": "text",
    "buttonBorderColor": "text",
    "logoPosition": 1,
    "coverImagePosition": 1,
    "submissionImagePosition": 1,
    "fieldOptionColor": "text"
  },
  "header": {
    "title": "text",
    "subtitle": "text"
  },
  "body": {
    "buttonText": "text"
  },
  "footer": {
    "display": true,
    "displayLogo": true,
    "backgroundColor": "text",
    "title": "text",
    "text": "text",
    "textColor": "text",
    "iconColor": "text",
    "imagePosition": 1
  },
  "externalLink": {
    "website": "text",
    "twitter": "text",
    "facebook": "text",
    "instagram": "text",
    "linkedin": "text"
  },
  "submission": {
    "title": "text",
    "subtitle": "text",
    "titleColor": "text",
    "subtitleColor": "text"
  },
  "logo": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "footerLogo": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "cover": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "submissionImage": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "submissionCount": 1,
  "fields": [
    {
      "id": "text",
      "createdAt": "2026-03-14T20:57:48.883Z",
      "updatedAt": "2026-03-14T20:57:48.883Z",
      "dependencies": [
        "text"
      ],
      "dependencyOf": [
        "text"
      ],
      "group": "text",
      "required": true,
      "label": "text",
      "placeholder": "text",
      "verticalIndex": 1,
      "horizontalIndex": 1,
      "values": [
        "text"
      ],
      "allowCustomValue": true,
      "allowMinReplies": true,
      "minReplies": 1,
      "allowMaxReplies": true,
      "maxReplies": 1,
      "operator": "$and",
      "type": "NPS"
    }
  ],
  "fieldGroups": [
    {
      "id": "text",
      "createdAt": "2026-03-14T20:57:48.883Z",
      "updatedAt": "2026-03-14T20:57:48.883Z",
      "name": "text",
      "verticalIndex": 1
    }
  ],
  "fieldDependencies": [
    {
      "id": "text",
      "createdAt": "2026-03-14T20:57:48.883Z",
      "updatedAt": "2026-03-14T20:57:48.883Z",
      "field": "text",
      "dependsOnField": "text",
      "operator": "$and",
      "dependsOnFieldValues": [
        {
          "operator": "$eq",
          "value": "text"
        }
      ]
    }
  ],
  "targets": [
    {
      "id": "text",
      "createdAt": "2026-03-14T20:57:48.883Z",
      "updatedAt": "2026-03-14T20:57:48.883Z",
      "type": "BRAND",
      "enabled": true,
      "targetId": "text",
      "targetName": "text",
      "newReviewUri": "text"
    }
  ],
  "publiclyAvailable": true,
  "sendingChannels": [
    "SMS"
  ],
  "solicitationThreshold": 1,
  "resolicitationDelay": 1,
  "resolicitationMode": "ACCOUNT",
  "preRedirect": true,
  "preRedirectConfig": {
    "type": "NPS",
    "threshold": 1,
    "text": {
      "text": "text",
      "color": "text"
    },
    "button": {
      "text": "text",
      "color": "text",
      "backgroundColor": "text",
      "topic": {
        "text": "text",
        "color": "text"
      }
    },
    "nps": {
      "startText": "text",
      "endText": "text",
      "topic": {
        "text": "text",
        "color": "text"
      }
    },
    "csatStar": {
      "topic": {
        "text": "text",
        "color": "text"
      }
    },
    "csatSmiley": {
      "one": "text",
      "two": "text",
      "three": "text",
      "four": "text",
      "five": "text",
      "topic": {
        "text": "text",
        "color": "text"
      }
    },
    "binary": {
      "satisfied": "text",
      "unsatisfied": "text",
      "topic": {
        "text": "text",
        "color": "text"
      }
    }
  },
  "postRedirect": true,
  "postRedirectThreshold": 1,
  "emailLogo": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "emailCover": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  }
}

List surveys

post

Paramètres d'en-tête

X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Corps

application/json

limitnumber · min: 1 · max: 100Optionnel

Pagination limit

Default: 10

pagenumber · min: 1Optionnel

Page to retrieve

Default: 1

Réponses

201

The surveys have been successfully listed.

application/json

400

Invalid input format.

401

Unauthorized

post

/partners/survey/list

HTTPcURLJavaScriptPython

POST /partners/survey/list HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "limit": 10,
  "page": 1
}

{
  "items": [
    {
      "id": "text",
      "createdAt": "2026-03-14T20:57:48.883Z",
      "updatedAt": "2026-03-14T20:57:48.883Z",
      "name": "text",
      "description": "text",
      "language": "af",
      "enabled": true,
      "autoTranslate": true,
      "generalStyle": {
        "fieldRadius": "SHARP",
        "buttonRadius": "SHARP",
        "zoneColor": "text",
        "starBackgroundColor": "text",
        "starBorderColor": "text",
        "cardBorderColor": "text",
        "cardBackgroundColor": "text",
        "cardBorderRadius": "SHARP",
        "font": {
          "name": "text",
          "url": "text"
        },
        "titleColor": "text",
        "subtitleColor": "text",
        "groupColor": "text",
        "textColor": "text",
        "accentColor": "text",
        "dividerColor": "text",
        "backgroundColor": "text",
        "labelColor": "text",
        "placeholderColor": "text",
        "fieldBackgroundColor": "text",
        "fieldBorderColor": "text",
        "buttonTextColor": "text",
        "buttonBackgroundColor": "text",
        "buttonBorderColor": "text",
        "logoPosition": 1,
        "coverImagePosition": 1,
        "submissionImagePosition": 1,
        "fieldOptionColor": "text"
      },
      "header": {
        "title": "text",
        "subtitle": "text"
      },
      "body": {
        "buttonText": "text"
      },
      "footer": {
        "display": true,
        "displayLogo": true,
        "backgroundColor": "text",
        "title": "text",
        "text": "text",
        "textColor": "text",
        "iconColor": "text",
        "imagePosition": 1
      },
      "externalLink": {
        "website": "text",
        "twitter": "text",
        "facebook": "text",
        "instagram": "text",
        "linkedin": "text"
      },
      "submission": {
        "title": "text",
        "subtitle": "text",
        "titleColor": "text",
        "subtitleColor": "text"
      },
      "logo": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "footerLogo": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "cover": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "submissionImage": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "submissionCount": 1,
      "fields": [
        {
          "id": "text",
          "createdAt": "2026-03-14T20:57:48.883Z",
          "updatedAt": "2026-03-14T20:57:48.883Z",
          "dependencies": [
            "text"
          ],
          "dependencyOf": [
            "text"
          ],
          "group": "text",
          "required": true,
          "label": "text",
          "placeholder": "text",
          "verticalIndex": 1,
          "horizontalIndex": 1,
          "values": [
            "text"
          ],
          "allowCustomValue": true,
          "allowMinReplies": true,
          "minReplies": 1,
          "allowMaxReplies": true,
          "maxReplies": 1,
          "operator": "$and",
          "type": "NPS"
        }
      ],
      "fieldGroups": [
        {
          "id": "text",
          "createdAt": "2026-03-14T20:57:48.883Z",
          "updatedAt": "2026-03-14T20:57:48.883Z",
          "name": "text",
          "verticalIndex": 1
        }
      ],
      "fieldDependencies": [
        {
          "id": "text",
          "createdAt": "2026-03-14T20:57:48.883Z",
          "updatedAt": "2026-03-14T20:57:48.883Z",
          "field": "text",
          "dependsOnField": "text",
          "operator": "$and",
          "dependsOnFieldValues": [
            {
              "operator": "$eq",
              "value": "text"
            }
          ]
        }
      ],
      "targets": [
        {
          "id": "text",
          "createdAt": "2026-03-14T20:57:48.883Z",
          "updatedAt": "2026-03-14T20:57:48.883Z",
          "type": "BRAND",
          "enabled": true,
          "targetId": "text",
          "targetName": "text",
          "newReviewUri": "text"
        }
      ],
      "publiclyAvailable": true,
      "sendingChannels": [
        "SMS"
      ],
      "solicitationThreshold": 1,
      "resolicitationDelay": 1,
      "resolicitationMode": "ACCOUNT",
      "preRedirect": true,
      "preRedirectConfig": {
        "type": "NPS",
        "threshold": 1,
        "text": {
          "text": "text",
          "color": "text"
        },
        "button": {
          "text": "text",
          "color": "text",
          "backgroundColor": "text",
          "topic": {
            "text": "text",
            "color": "text"
          }
        },
        "nps": {
          "startText": "text",
          "endText": "text",
          "topic": {
            "text": "text",
            "color": "text"
          }
        },
        "csatStar": {
          "topic": {
            "text": "text",
            "color": "text"
          }
        },
        "csatSmiley": {
          "one": "text",
          "two": "text",
          "three": "text",
          "four": "text",
          "five": "text",
          "topic": {
            "text": "text",
            "color": "text"
          }
        },
        "binary": {
          "satisfied": "text",
          "unsatisfied": "text",
          "topic": {
            "text": "text",
            "color": "text"
          }
        }
      },
      "postRedirect": true,
      "postRedirectThreshold": 1,
      "emailLogo": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "emailCover": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      }
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  }
}