> ## Documentation Index > Fetch the complete documentation index at: https://docs.repdata.com/llms.txt > Use this file to discover all available pages before exploring further. # List Surveys & Streams Returns the Surveys and Streams allocated to you (your "supplier allocations"). A Stream represents a sample plan, each with its own qualifications and quotas; multiple Streams may route into one Survey. ##### Query String Parameters | Parameter | Description | Required | Example | | --------- | ------------------------------------------------------------------------ | -------- | -------------- | | `status` | Filter Surveys by status. Values: `Draft`, `Live`, `Paused`, `Complete`. | No | `?status=Live` | ##### Key Response Fields | Field | Description | | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SurveyNumber` | Survey identifier. Use `SurveyNumber` and `StreamId` in any communication with our team about projects and performance. | | `ProjectUd` | UD for the parent project. Use this value for any Research Defender PREDUPE implementation. | | `CalculationType` | Whether targets are counted per `Completes` or `Survey Starts`. Completes are respondents who qualified and finished end to end; Survey Starts are respondents who entered the client survey. | | `Expected` / `Actual` | Required vs. achieved Completes (or Survey Starts) for the supplier. Use these rather than the deprecated `ExpectedStreamCompletes` / `ActualStreamCompletes`. | | `Remaining` | Completes (or Survey Starts) still needed. **Use this as the main indicator of whether more respondents are needed. When `Remaining` = 0, pause sample to the quota cell.** | | `QualificationsLastChangedTimestamp` | Updated when a Stream's qualifications change; use it to prompt a refresh. | | `QuotasLastChangedTimestamp` | Updated when a Stream's quotas change (including when a quota closes). Not updated on every increment. | | `B2B` | Derived field indicating whether the Stream seeks B2B respondents. | > Poll this endpoint every 2–3 minutes during fieldwork to detect status, allocation, and quota changes. ## OpenAPI ````yaml GET /v2/surveys openapi: 3.0.3 info: title: Research Desk Supply API version: 1.0.0 description: >- Rep Data's sample platform, Research Desk, lets sample suppliers integrate via API for programmatic sample order placement and fulfillment. The Supply API is a RESTful service that returns JSON. Suppliers retrieve available survey opportunities (Surveys and Streams), read the qualifications and quotas attached to each Stream, generate respondent entry links, and reconcile completed sessions. ## Authentication Authentication is done via an obfuscated GUID (API key) associated with each supplier and passed in the `Authorization` header of every request. To obtain credentials, contact Rep Data's Supply team at supply@repdata.com. ## Environments Production URL: `https://api.researchdesk.com` Staging URL: `https://stage-api.researchdesk.com` We recommend completing full end-to-end testing in staging before going live. Staging test surveys 2634 (short, 1 question) and 2635 (longer, ~10 minutes) are available for integration testing. ## Responses Successful responses are wrapped in a standard envelope: ``` json { "Status": 0, "Message": "Success", "Data": { } } ``` A `Status` of `0` indicates success. `Data` contains the endpoint-specific payload. servers: - url: https://api.researchdesk.com description: Production - url: https://stage-api.researchdesk.com description: Staging security: [] paths: /v2/surveys: get: summary: List Surveys & Streams operationId: Surveys_ListSurveys parameters: - name: Authorization in: header required: true description: Your obfuscated Supply API key (GUID), provided by Rep Data. schema: type: string example: '{{api_key}}' - name: status in: query required: false description: Filter Surveys by status (Draft, Live, Paused, Complete). schema: type: string example: Live responses: '200': description: Supplier allocations (surveys and streams). content: application/json: schema: type: object properties: Status: type: integer description: 0 indicates success. Message: type: string Data: type: array items: type: object properties: SurveyName: type: string SurveyNumber: type: integer ProjectUd: type: string format: uuid description: >- UD for the parent project; used for Research Defender PREDUPE. SurveyUd: type: string format: uuid SurveyStatus: type: string description: Draft, Live, Paused, Complete. SurveyLanguage: type: string SurveyCountry: type: string PII: type: boolean EstimatedLOI: type: integer EstimatedIR: type: integer DeviceCompatibility: type: array items: type: object properties: device_id: type: integer device_name: type: string SampleExclusions: type: array items: type: string format: uuid Streams: type: array items: type: object properties: StreamId: type: integer StreamUd: type: string format: uuid StreamName: type: string StreamStatus: type: string description: Draft, Live, Paused, Complete, Canceled. CalculationType: type: string description: Completes or Survey Starts. Entrants: type: integer ExpectedStreamCompletes: type: integer description: Deprecated. Use Expected instead. ActualStreamCompletes: type: integer description: Deprecated. Use Actual instead. Expected: type: integer Actual: type: integer ActualIR: type: integer ActualLOI: type: integer CPI: type: number format: float DaysInField: type: integer Conversion: type: integer Remaining: type: integer description: >- Completes or Survey Starts still needed. Pause sample when 0. QualificationsLastChangedTimestamp: type: string format: date-time QuotasLastChangedTimestamp: type: string format: date-time B2B: type: boolean example: Status: 0 Message: Success Data: - SurveyName: US Gen Pop Survey - Short SurveyNumber: 2634 ProjectUd: db02d54e-9b65-4a49-bb22-cfeec3a3fb62 SurveyUd: d6cee0a1-3c4c-4252-b502-d3dae24db9ff SurveyStatus: Live SurveyLanguage: en SurveyCountry: US PII: false EstimatedLOI: 2 EstimatedIR: 100 DeviceCompatibility: - device_id: 1 device_name: Desktop - device_id: 2 device_name: Mobile - device_id: 3 device_name: Tablet SampleExclusions: - 63099002-c17f-4fda-b8c8-29d7f33c625c - 550d11c7-1b0e-4276-a96a-72004ad0bac9 Streams: - StreamId: 850 StreamUd: f1789d2b-ac7c-415b-bcb5-8b285e60e698 StreamName: US Gen Pop - Census Rep StreamStatus: Live CalculationType: Completes Entrants: 0 ExpectedStreamCompletes: 0 ActualStreamCompletes: 0 Expected: 0 Actual: 0 ActualIR: 0 ActualLOI: 0 CPI: 0 DaysInField: 1 Conversion: 0 Remaining: 0 QualificationsLastChangedTimestamp: '2024-06-18 17:41:22' QuotasLastChangedTimestamp: '2024-06-18 17:41:22' B2B: false - StreamId: 853 StreamUd: 1ff36ea1-8181-406c-8c2c-45fc44f4f3f5 StreamName: High Income, Employed StreamStatus: Live CalculationType: Completes Entrants: 0 ExpectedStreamCompletes: 8 ActualStreamCompletes: 0 Expected: 8 Actual: 0 ActualIR: 0 ActualLOI: 0 CPI: 0 DaysInField: 5 Conversion: 0 Remaining: 8 QualificationsLastChangedTimestamp: '2024-06-18 17:41:22' QuotasLastChangedTimestamp: '2024-06-18 17:41:22' B2B: false ````