Components

ResponseField

Document API response values and structure

ResponseField components help you document API response structures clearly.

Basic Usage

Response

idstring

Unique identifier for the created resource

created_atstring

ISO 8601 timestamp of creation

status'active' | 'pending' | 'inactive'

Current status of the resource

<ResponseFieldGroup title="Response">
  <ResponseField name="id" type="string">
    Unique identifier for the created resource
  </ResponseField>
  <ResponseField name="created_at" type="string">
    ISO 8601 timestamp of creation
  </ResponseField>
  <ResponseField name="status" type="'active' | 'pending' | 'inactive'">
    Current status of the resource
  </ResponseField>
</ResponseFieldGroup>

Complex Response

User Response

dataobject

The user object containing all user information

data.idstring

Unique user identifier

data.emailstring

User’s email address

data.profileobject

User’s profile information

data.profile.namestring

Display name

data.profile.avatar_urlstring | null

Profile image URL, null if not set

metaobject

Pagination and request metadata

meta.totalnumber

Total number of results

Props

ResponseFieldGroup

title - Group heading
className - Additional CSS classes

ResponseField

name (required) - Field name (supports dot notation)
type - Field type
children - Field description