respondents
Get a respondent by query parameters
Get a respondent query parameters. Requires either an ID, or any of email, firstName and lastName
get/respondents
Query parameters
idsstring[]
The UUIDs to search for
firstNamestring
The first name of the respondent
lastNamestring
The last name of the respondent
emailstring email
The email address of the respondent
pageinteger
The page number of results
limitinteger
The number of results per page
Response
The respondent(s) have been retrieved
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"
}
]
}
]
}
]