---
title: "Get a respondent by query parameters"
method: GET
path: "/respondents"
tags: ["respondents"]
---

# Get a respondent by query parameters

`GET /respondents`

Get a respondent query parameters. Requires either an ID, or any of email, firstName and lastName

## Query parameters

- `ids` string[]
- `firstName` string
- `lastName` string
- `email` string, email
- `page` integer
- `limit` integer

## Response `200`

The respondent(s) have been retrieved

- union
  - RespondentWithAssociations[]
    - `id` string, uuid
    - `sampleUnitType` string
    - `pendingEmailAddress` string, email
    - `firstName` string
    - `lastName` string
    - `telephone` string
    - `status` 'CREATED' | 'ACTIVE' | 'SUSPENDED'
    - `markForDeletion` boolean
    - `passwordVerificationToken` string
    - `passwordResetCounter` integer
    - `associations` Association[]
      - `partyId` string, uuid
      - `sampleUnitRef` string, string
      - `businessRespondentStatus` 'CREATED' | 'ACTIVE' | 'SUSPENDED'
      - `enrolments` Enrolment[]
        - `surveyId` string, uuid
        - `enrolmentStatus` 'PENDING' | 'ENABLED' | 'DISABLED' | 'SUSPENDED'
  - object
    - `data` RespondentWithAssociations[]
      - `id` string, uuid
      - `sampleUnitType` string
      - `pendingEmailAddress` string, email
      - `firstName` string
      - `lastName` string
      - `telephone` string
      - `status` 'CREATED' | 'ACTIVE' | 'SUSPENDED'
      - `markForDeletion` boolean
      - `passwordVerificationToken` string
      - `passwordResetCounter` integer
      - `associations` Association[]
        - `partyId` string, uuid
        - `sampleUnitRef` string, string
        - `businessRespondentStatus` 'CREATED' | 'ACTIVE' | 'SUSPENDED'
        - `enrolments` Enrolment[]
          - `surveyId` string, uuid
          - `enrolmentStatus` 'PENDING' | 'ENABLED' | 'DISABLED' | 'SUSPENDED'
    - `total` integer

## Other responses

- `400` — The request was missing the ID query parameter, or the provided ID wasn't a UUID, or the request was missing one or more of email, firstName and lastName if no ID was provided

---

[API](https://skmtc.net/office-of-national-statistics/apis/party-service-api.md) · [All operations](https://skmtc.net/office-of-national-statistics/apis/party-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/office-of-national-statistics/party-service-api/revisions/a9abfd072409/schema)
