Expandables

Toggle to display nested properties

Use expandables to show and hide nested content within response fields. Expandables are particularly useful for displaying complex object properties in API documentation.

user · User Object

Show properties

full_name · string

The full name of the user

is_over_21 · boolean

Whether the user is over 21 years old

Expandable example

<ResponseField name="user" type="User Object">
  <Expandable title="properties">
    <ResponseField name="full_name" type="string">
      The full name of the user
    </ResponseField>

    <ResponseField name="is_over_21" type="boolean">
      Whether the user is over 21 years old
    </ResponseField>
  </Expandable>
</ResponseField>

Properties

title · string

The name of the object you are showing.

defaultOpen · boolean · default: "false"

Set to true for the expandable to open when the page loads