> ## 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.

# Get Stream Lists

> Returns lists of values for a Stream. The first list type is `recontact`: PIDs eligible for a stream whose `Recontact` field is true.

Staging base URL for this endpoint is `https://stage-api.researchdesk.com`. Production is `https://api.researchdesk.com`.

Only respondents whose PIDs are returned with `type` `recontact` are eligible for that recontact stream. They must also match the stream's qualifications and quotas. Respondents sent without a matching PID are termed with isc `5008` (Respondent List Mismatch). Future list types (for example `exclude`) may appear on this endpoint; use only results whose `type` is `recontact`.

Returns lists of values for a Stream. The first list type is `recontact`: the supplier PIDs eligible for a stream designated as a recontact.

##### Path Parameters

| Parameter | Description | Required | Example |
| - | - | - | - |
| `StreamNumber` | The `StreamNumber` of the stream. | Yes | `11886` |

##### Environments

| Environment | URL |
| - | - |
| Staging | `https://stage-api.researchdesk.com/v2/lists/streams/{StreamNumber}` |
| Production | `https://api.researchdesk.com/v2/lists/streams/{StreamNumber}` |

##### How to use it

1. On [List Surveys & Streams](https://docs.repdata.com/supply/endpoints/get-v2-surveys), check the stream object for `"Recontact": true`.
2. Call this endpoint to retrieve the PIDs eligible for that stream.
3. Send only those respondents. The incoming `pid` must match a PID in the list, and the respondent must still match the stream's qualifications and quotas.

```json theme={null}
{
  "Status": 0,
  "Message": "Success",
  "Data": [
    {
      "type": "recontact",
      "total": 5,
      "results": [
        { "pid": "SupplierPID0004" },
        { "pid": "SupplierPID0002" },
        { "pid": "SupplierPID0001" },
        { "pid": "SupplierPID0003" },
        { "pid": "SupplierPID0005" }
      ]
    }
  ]
}
```

A recontact stream on the Surveys response looks like this:

```json theme={null}
"Streams": [
  {
    "StreamId": 11886,
    "Recontact": true
  }
]
```

<Warning>
  Only respondents whose PIDs are returned with `"type": "recontact"` are eligible for that stream. A respondent sent without a matching PID is termed with `isc` `5008` (Respondent List Mismatch). Other list types (for example `exclude`) may be added later — use results only when `type` is `recontact`.
</Warning>


## OpenAPI

````yaml GET /v2/lists/streams/{StreamNumber}
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/lists/streams/{StreamNumber}:
    get:
      summary: Get Stream Lists
      description: >-
        Returns lists of values for a Stream. The first list type is
        `recontact`: PIDs eligible for a stream whose `Recontact` field is true.


        Staging base URL for this endpoint is
        `https://stage-api.researchdesk.com`. Production is
        `https://api.researchdesk.com`.


        Only respondents whose PIDs are returned with `type` `recontact` are
        eligible for that recontact stream. They must also match the stream's
        qualifications and quotas. Respondents sent without a matching PID are
        termed with isc `5008` (Respondent List Mismatch). Future list types
        (for example `exclude`) may appear on this endpoint; use only results
        whose `type` is `recontact`.
      operationId: Lists_GetStreamLists
      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: StreamNumber
          in: path
          required: true
          description: StreamNumber (integer) of the recontact stream.
          schema:
            type: string
          example: '11886'
      responses:
        '200':
          description: Lists attached to the stream.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: integer
                    description: 0 indicates success.
                  Message:
                    type: string
                  Data:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          description: >-
                            List type. Use `recontact` for eligible recontact
                            PIDs.
                          example: recontact
                        total:
                          type: integer
                          description: Number of values in the list.
                        results:
                          type: array
                          items:
                            type: object
                            properties:
                              pid:
                                type: string
                                description: Supplier panelist ID eligible for the stream.
              example:
                Status: 0
                Message: Success
                Data:
                  - type: recontact
                    total: 5
                    results:
                      - pid: SupplierPID0004
                      - pid: SupplierPID0002
                      - pid: SupplierPID0001
                      - pid: SupplierPID0003
                      - pid: SupplierPID0005

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.