v9

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-15521353.8 KB

respondents

Get respondents by survey and business

get/respondents/survey_id/{survey_id}/business_id/{business_id}

Path parameters

survey_idstring uuid required

The UUID of the survey

business_idstring uuid required

The UUID of the business

Response

The respondents have been retrieved

enrolment_status'PENDING' | 'ENABLED' | 'DISABLED' | 'SUSPENDED'

Example response

[
  {
    "respondent": {
      "id": "91e0bb4f-ffad-404c-af1b-01c87037119c",
      "sampleUnitType": "BI",
      "pendingEmailAddress": "example@ons.gov.uk",
      "firstName": "Jane",
      "lastName": "Doe",
      "associations": [
        {
          "partyId": "91e0bb4f-ffad-404c-af1b-01c87037119c",
          "enrolments": [
            {
              "surveyId": "91e0bb4f-ffad-404c-af1b-01c87037119c"
            }
          ]
        }
      ]
    }
  }
]