> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.manicule.dev/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://mintlify.manicule.dev/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://mintlify.manicule.dev/api/mcp.
> Every agent surface: https://mintlify.manicule.dev/.well-known/llms-manifest.json

# Response fields (/components/responses)

<!-- agent-signals: reading_time_min: 1 · est_tokens: 364 · updated: 2026-07-31 -->
Related: [Accordions](/components/accordions.md), [Badge](/components/badge.md), [Banner](/components/banner.md), [Callouts](/components/callouts.md), [Cards](/components/cards.md), [Code groups](/components/code-groups.md)

> Document API response fields using the ResponseField component with type annotations, descriptions, and required or optional indicators.

Use the `<ResponseField>` component to define the return values of an API. Many docs also use `<ResponseField>` on pages when you need to list the types of something.

<ResponseField name="response" type="string" required>A response field example</ResponseField>

```mdx
<ResponseField name="response" type="string" required>
  A response field example
</ResponseField>
```

## Props

<ResponseField name="name" type="string" required>The name of the response value.</ResponseField>

<ResponseField name="type" type="string" required>Expected type of the response value - this can be any arbitrary string.</ResponseField>

<ResponseField name="default" type="string">The default value.</ResponseField>

<ResponseField name="required" type="boolean">Show "required" beside the field name.</ResponseField>

<ResponseField name="deprecated" type="boolean">Whether you have deprecated a field or not.</ResponseField>

<ResponseField name="pre" type="string[]">Labels that appear before the name of the field</ResponseField>

<ResponseField name="post" type="string[]">Labels that appear after the name of the field</ResponseField>

<RequestExample>
  ```mdx title="Response Field Example"
  <ResponseField name="response" type="string" required>
    A response field example
  </ResponseField>
  ```
</RequestExample>