v9

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

Get a business or respondent by ID

Get a business or respondent by ID. Use GET /businesses/id/{id} or GET /respondents/id/{respondent_id} instead

get/parties/type/{sample-unit-type}/id/{id}

Path parameters

sample-unit-type'B' | 'BI' required

The sample unit type (B for business, BI for respondent)

idstring uuid required

The UUID of the business or respondent

Query parameters

survey_idstring uuid

The UUID of the survey

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

The enrolment status

Response

The business or respondent has been retrieved

OR

Example response

{
  "id": "91e0bb4f-ffad-404c-af1b-01c87037119c",
  "sampleSummaryId": "91e0bb4f-ffad-404c-af1b-01c87037119c",
  "attributes": {
    "birthdate": "1990-01-01",
    "checkletter": "A",
    "currency": "GBP",
    "runame1": "Office for National Statistics",
    "runame2": "ONS",
    "runame3": "UK Statistics Authority"
  },
  "name": "Office for National Statistics",
  "trading_as": "ONS",
  "associations": [
    {
      "partyId": "91e0bb4f-ffad-404c-af1b-01c87037119c",
      "enrolments": [
        {
          "surveyId": "91e0bb4f-ffad-404c-af1b-01c87037119c"
        }
      ]
    }
  ]
}