Response fields

<ResponseField name="response" type="string" required>

  A response field example

</ResponseField>

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.

string

required

A response field example

<ResponseField name="response" type="string" required>

  A response field example

</ResponseField>

string

required

The name of the response value.

string

required

Expected type of the response value. This can be any arbitrary string.

string

The default value.

boolean

Show “required” beside the field name.

boolean

Whether you have deprecated a field or not.

string[]

Labels that appear before the name of the field.

string[]

Labels that appear after the name of the field.

<ResponseField name="response" type="string" required>

  A response field example

</ResponseField>

⌘I