v9

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

respondents

Get a respondent by ID

get/respondents/id/{id}

Path parameters

idstring uuid required

The UUID of the respondent

Response

The respondent has been retrieved

idstring uuid

sampleUnitTypestring

pendingEmailAddressstring email

firstNamestring

lastNamestring

telephonestring

status'CREATED' | 'ACTIVE' | 'SUSPENDED'

markForDeletionboolean

passwordVerificationTokenstring

passwordResetCounterinteger

Example response

{
  "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"
        }
      ]
    }
  ]
}