Ctrlk
Réserver un appelSe connecter
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Survey

Get a survey by ID

get
Query parameters
idstringRequired

The UUID of the survey to retrieve

Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses
200

The survey has been successfully retrieved.

application/json
idstringRequired

Unique identifier

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

namestringRequired

Internal form name.

descriptionstring · nullableRequired

Internal form description.

Default: null
languagestring · enumRequired

Language used to generate review responses

Possible values:
enabledbooleanRequired

Determines if the form is enabled.

autoTranslatebooleanRequired

Whether to automatically translate the form.

submissionCountnumberRequired

Number of submissions recorded for this form.

publiclyAvailablebooleanRequired

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

solicitationThresholdnumberRequired

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.

resolicitationDelaynumberRequired

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

resolicitationModestring · enumRequired

Determines the mode of resolicitation

Possible values:
preRedirectbooleanRequired

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

postRedirectbooleanRequired

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

postRedirectThresholdnumber · nullableRequired

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
get/partners/survey
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-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "description": "text",
  "language": "af",
  "enabled": true,
  "autoTranslate": true,
  "generalStyle": {
    "fieldRadius": "SHARP",
    "buttonRadius": "SHARP",
    "zoneColor": "text",
    "starBackgroundColor": "text",
    "starFilledBackgroundColor": "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-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "verticalIndex": 1
    }
  ],
  "fieldDependencies": [
    {
      "id": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "field": "text",
      "dependsOnField": "text",
      "operator": "$and",
      "dependsOnFieldValues": [
        {
          "operator": "$eq",
          "value": "text"
        }
      ]
    }
  ],
  "targets": [
    {
      "id": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "type": "BRAND",
      "enabled": true,
      "targetId": "text",
      "targetName": "text",
      "newReviewUri": "text"
    }
  ],
  "publiclyAvailable": true,
  "supportEmail": {
    "id": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "email": "text",
    "domain": "text",
    "forwardingEmail": "text",
    "default": true,
    "enableInbound": true,
    "externalDnsConfig": {
      "dkim": {
        "host": "text",
        "type": "text",
        "value": "text"
      },
      "returnPath": {
        "host": "text",
        "type": "text",
        "value": "text"
      }
    },
    "dkimVerified": true,
    "returnPathVerified": 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
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
limitnumber · min: 1 · max: 100Optional

Pagination limit

Default: 10
pagenumber · min: 1Optional

Page to retrieve

Default: 1
Responses
201

The surveys have been successfully listed.

application/json
post/partners/survey/list
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-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "description": "text",
      "language": "af",
      "enabled": true,
      "autoTranslate": true,
      "generalStyle": {
        "fieldRadius": "SHARP",
        "buttonRadius": "SHARP",
        "zoneColor": "text",
        "starBackgroundColor": "text",
        "starFilledBackgroundColor": "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-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "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-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "name": "text",
          "verticalIndex": 1
        }
      ],
      "fieldDependencies": [
        {
          "id": "text",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "field": "text",
          "dependsOnField": "text",
          "operator": "$and",
          "dependsOnFieldValues": [
            {
              "operator": "$eq",
              "value": "text"
            }
          ]
        }
      ],
      "targets": [
        {
          "id": "text",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "type": "BRAND",
          "enabled": true,
          "targetId": "text",
          "targetName": "text",
          "newReviewUri": "text"
        }
      ],
      "publiclyAvailable": true,
      "supportEmail": {
        "id": "text",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "email": "text",
        "domain": "text",
        "forwardingEmail": "text",
        "default": true,
        "enableInbound": true,
        "externalDnsConfig": {
          "dkim": {
            "host": "text",
            "type": "text",
            "value": "text"
          },
          "returnPath": {
            "host": "text",
            "type": "text",
            "value": "text"
          }
        },
        "dkimVerified": true,
        "returnPathVerified": 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
  }
}
PreviousSurvey Tracker
NextContact Form

Last updated