> ## Documentation Index
> Fetch the complete documentation index at: https://docs.holydocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ResponseField

Documents a field in an API response body with its name, type, and description.

**Interactive playground** For isolated previews, theme switching, and sandbox editing, open [the ResponseField playground on holydocs.com](https://holydocs.com/components/response-field).

## When to use

Use this component when endpoint documentation needs explicit request, response, schema, or lifecycle metadata.

## Live Examples

Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.

### Basic

A standard response field.

**id**

Unique identifier for the project, prefixed with `proj_`.

~~~mdx
<ResponseField name="id" type="string">
  Unique identifier for the project, prefixed with `proj_`.
</ResponseField>
~~~

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `name` | `string` | `field` | Field name as returned in the JSON response. |
| `type` | `string` | `string` | Data type of the response field. |

## Usage

Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.

~~~mdx
<ResponseField name="id" type="string">
  Unique identifier for the project, prefixed with `proj_`.
</ResponseField>
~~~

## Tips

- Keep naming and ordering consistent across fields, examples, and lifecycle notes so readers do not have to re-parse the endpoint surface on every page.
- Document the happy path and the sharp edges together. Request shape alone is not enough without auth, errors, and retry guidance.
- If a component renders into the right panel, verify the page on desktop width so you can confirm the supporting example is visible where readers expect it.

## Related Components

**[ParamField](/components/param-field)**

Documents a request parameter — path, query, or body — with type, requirement status, and description.
**[Expandable](/components/expandable)**

Collapsible section for nested API fields, keeping complex response shapes readable.
**[RequestExample](/components/request-example)**

Pin request code examples in the right-side panel alongside API endpoint documentation.

## More

- Interactive playground: [ResponseField on holydocs.com](https://holydocs.com/components/response-field)
- Component library index: [/components](/components)