Response Format

For AI agents: visit https://developer.usebutton.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Responses are delivered in JSON, and may have the following fields:

• meta: Response metadata. Always present.

• status: Either "ok" or "error" depending on response code.

• object or objects: Endpoints that return a single object shall return it

as object, while endpoints that return collections shall use objects.

• error: Error information. Only for error responses.

• message: Human-readable reason for error.

  • type (optional): Button-global slug for the current error condition.
  • details (optional): Any accessory details for the given error.type.

Some error types may use this to communicate additional information about

the current condition.

Updatedabout 1 year ago

Did this page help you?

Yes

No

Updatedabout 1 year ago

Did this page help you?

Yes

No