v9

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

misc

Get pending survey transfers or shares by batch number

get/pending-surveys/{batch-no}

Path parameters

batch-nointeger required

The batch number to retrieve

Response

The pending survey transfers or shares have been retrieved

email_addressstring email

business_idstring uuid

survey_idstring uuid

shared_bystring uuid

batch_nointeger

is_transferboolean

time_sharedstring date-time

Example response

[
  {
    "email_address": "ons@ons.gov.uk",
    "business_id": "91e0bb4f-ffad-404c-af1b-01c87037119c",
    "survey_id": "91e0bb4f-ffad-404c-af1b-01c87037119c",
    "shared_by": "91e0bb4f-ffad-404c-af1b-01c87037119c",
    "batch_no": 1,
    "is_transfer": true,
    "time_shared": "2020-01-01T00:00:00Z"
  }
]