Get Recontacts

Sandbox Env

https://supplier-stage.surveysherpa.com

GET

/api/v1/supply/getRecontacts/{Survey ID}

The API helps suppliers determine which users are eligible to attend a survey based on the following parameters:

includedPIDs: These are the user IDs (PIDs) explicitly allowed to attend the survey. Only the users listed here are eligible to participate.

excludedPIDs: These are the user IDs (PIDs) explicitly restricted from attending the survey. Users listed here are not allowed to participate in the survey.

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://supplier-stage.surveysherpa.com/api/v1/supply/getRecontacts/5128' \
--header 'x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NTI3Y2JlZDdiZTE0MzFmNjM0N2FhZGQiLCJzdXBwbGllcl9pZCI6MTI0LCJpYXQiOjE3Mzg5MDk1NDV9.0F0N6CwmJqim45F5PHNAV5DchgZRfWk16B6edAplTfk'

Responses

🟢200Success

application/json

Body

Example

{
    "apiStatus": "success",
    "msg": "Recontact PIDs successfully fetched",
    "result": {
        "includedPIDs": [
            "OG6YMJukn4FnBxPJVuOh6BPq",
            "OG7ovhwlTWUxLiwaKWBbH0FI"
        ],
        "excludedPIDs": [
            "OG5fzCFxEYvFCLjZXHxqppsA",
            "OG1roR0pYg1Jwib1PFjGHSnC"
        ]
    }
}

Modified at 2025-09-02 12:55:15

Get Survey Stats