# Fields (/components/fields)

<!-- agent-signals: reading_time_min: 1 · est_tokens: 648 · updated: 2026-07-30 -->
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)

Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields.

## Parameter field [#parameter-field]

Use the `<ParamField>` component to define parameters for your APIs or SDKs. Adding a `ParamField` automatically adds an [API Playground](/api-playground/overview).

<ParamField path="param" type="string">
  An example of a parameter field
</ParamField>

```mdx
<ParamField path="param" type="string" required>
  An example of a parameter field
</ParamField>
```

### Properties [#properties]

<ParamField body="query, path, body, or header" type="string">
  Whether the parameter is a query, path, body, or header. Followed by the
  parameter name.
</ParamField>

<ParamField body="type" type="string">
  Expected type of the parameter's value.

  Supports `number`, `string`, `boolean`, `object`.

  Define arrays using the `[]` suffix. For example `string[]`.
</ParamField>

<ParamField body="required" type="boolean">
  Indicate whether you require the parameter.
</ParamField>

<ParamField body="deprecated" type="boolean">
  Indicate whether you have deprecated the parameter.
</ParamField>

<ParamField body="default" type="any">
  Default value populated when the request value is empty
</ParamField>

<ParamField body="placeholder" type="string">
  Placeholder text for the input in the playground.
</ParamField>

<ParamField body="children" type="string">
  Description of the parameter (Markdown-enabled).
</ParamField>

## Response field [#response-field]

The `<ResponseField>` component defines the return values of an API.

<ResponseField name="response" type="string">
  An example of a response field
</ResponseField>

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

### Properties [#properties-1]

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

<ResponseField name="type" type="string">
  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">
  Indicate whether you require the response.
</ResponseField>

<ResponseField name="deprecated" type="boolean">
  Whether you have deprecated a field.
</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>