API Reference

Types

An overview of each entity / resource provided by this API.

⚠️ Currently in-progress

The Types section is currently incomplete. There are still a handful of Types that need to be documented. Please check back soon or reach out to us if you need help with something specific in the meantime.

We attempt to do our very best with documenting all entities / resources provided by this API. Each documented "Type" has the following sub sections:

Attributes

This section defines the attributes that represent the resource along with their data type and what they mean.

Allowed includes

This section defines the allowed includes the resource accepts. See Making requests / Includes to learn more.

Allowed filters

This section defines the allowed filters the resource accepts. See Making requests / Filters to learn more.

Allowed sorts

This section defines the allowed sorts the resource accepts. See Making requests / Sorts to learn more.