Working with the API
Resource Embedding
Our API supports including related resources in a single API call. This reduces the need for many API requests.
This is an advanced feature. Only start using it if you are comfortable with our API.
Many-to-One Relationships
Since a message
always has a conversation
, they have a many-to-one relationship. This enables us to request all the messages and the conversation for each message.
Note that the embedded conversation
is returned as a JSON object because of the “to-one” end.
One-to-Many Relationships
The foreign key reference establishes the inverse one-to-many relationship. In this case, message returns as a JSON array because of the “to-many” end.
Many-to-Many Relationships
In this example, a conversation
has tag
s assigned via a conversation_tag
relation. This is a many-to-many relationship.