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

# Response Structure

> The standard JSON response envelope and status conventions for the Research Desk Supply API.

All endpoints return JSON. POST and PUT requests must send `Content-Type: application/json`.

## Success Responses

Successful responses are wrapped in a standard envelope. A `Status` of `0` indicates success, and `Data` contains the endpoint-specific payload — either an object or an array of objects.

```json theme={null}
{
    "Status": 0,
    "Message": "Success",
    "Data": { }
}
```

| Field     | Description                                                       |
| --------- | ----------------------------------------------------------------- |
| `Status`  | `0` indicates success.                                            |
| `Message` | Human-readable status message (e.g. `"Success"`).                 |
| `Data`    | The endpoint-specific payload — an object or an array of objects. |

## Payload Shapes

<Tabs>
  <Tab title="Object">
    Single-resource endpoints return an object in `Data` — for example, [Get Survey](https://docs.repdata.com/supply/endpoints/get-v2-surveys-SurveyNumber) or [Create Links](https://docs.repdata.com/supply/endpoints/post-v2-surveys-streams-StreamNumber-link).

    ```json theme={null}
    {
      "Status": 0,
      "Message": "Success",
      "Data": {
        "LiveLinkUD": "d026d369-b370-4ffa-8177-c75cf46026f7",
        "LiveLinkURL": "https://www-staging.researchdesk.com/landing2?fttsn=d026d369-b370-4ffa-8177-c75cf46026f7&rid=[%RID%]"
      }
    }
    ```
  </Tab>

  <Tab title="Array">
    List endpoints return an array in `Data` — for example, [List Surveys & Streams](https://docs.repdata.com/supply/endpoints/get-v2-surveys) or [Get Stream Quotas](https://docs.repdata.com/supply/endpoints/get-v2-surveys-streams-StreamNumber-quotas).

    ```json theme={null}
    {
      "Status": 0,
      "Message": "Success",
      "Data": [
        { "SurveyName": "US Gen Pop Survey - Short", "SurveyNumber": 2634, "SurveyStatus": "Live" }
      ]
    }
    ```
  </Tab>
</Tabs>

<Note>
  The supplier-facing **disposition** of a respondent is communicated separately via the `isc` status code appended to your redirect links — not in this API envelope. See [Respondent Status Codes](/supply/overview/04-respondent-status-codes).
</Note>