1. Supplier API
  • Supplier API
    • Guides
    • Get Global Definitions
      GET
    • Question Library
      GET
    • Answer Library
      GET
    • Get Available Surveys
      GET
    • Get Survey By Id
      GET
    • Get Survey Transactions Data
      GET
    • Get Survey Stats
      GET
    • Get Recontacts
      GET
  1. Supplier API

Get Recontacts

GET
https://supplier.opnion.io/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

Responses

🟢200Success
application/json
Body

Example
{
    "apiStatus": "success",
    "msg": "Recontact PIDs successfully fetched",
    "result": {
        "includedPIDs": [
            "OG6YMJukn4FnBxPJVuOh6BPq",
            "OG7ovhwlTWUxLiwaKWBbH0FI"
        ],
        "excludedPIDs": [
            "OG5fzCFxEYvFCLjZXHxqppsA",
            "OG1roR0pYg1Jwib1PFjGHSnC"
        ]
    }
}
Modified at 2025-02-24 10:25:59
Previous
Get Survey Stats
Built with