Skip to main content
Every object the API returns is defined once in this section. Endpoint pages in the API Reference show these same definitions inline; the pages here are the standalone reference for each object’s fields, types, and nullability.

​
Resources

Resource types describe the objects you create, read, update, and delete — a User, a Contact, and so on. Single-resource endpoints return the resource object directly, with no wrapper.

​
Envelopes

Envelope types describe the structures that wrap or accompany resources:
  • Pagination — the envelope every list endpoint returns, with the current page of records in data.
  • Error — the body of a generic error response.
  • Validation error — the 422 response body, with an errors object naming each invalid field.

​
Reading a definition

  • Fields marked nullable return null when no value is set.
  • Date fields are strings in YYYY-MM-DD format; timestamp fields are strings in YYYY-MM-DD HH:MM:SS format.
  • Fields only present when requested via include or append are noted on the endpoint pages that support them — see Relationships.