Objects structure and data

In our API, an object is a representation of a resource, like a user, a team, or a project. This article explains the common structure of object responses in our API.

Basic object structure

Each object in our API would typically contain an identifier, attributes, and relationships:

• Identifier: A unique id and type for the object.
• Attributes: A set of key-value pairs that hold the object's data.
• Relationships: Links to other resources that are related to this object.

Here's a typical response when you make a GET request to one of our resources:

{
  "data": {
    "id": "1",
    "type": "user",
    "attributes": {
      "name": "John Doe",
      "email": "johndoe@example.com",
      "role": "admin"
    },
    "relationships": {
      "team": {
        "data": { "id": "2", "type": "team" }
      }
    }
  }
}

Navigating relationships

Many objects in our API have relationships to other objects. In the relationships data, you will find links to make a GET request to view the related object(s).

Objects and HTTP methods

For any given object, you can use the appropriate HTTP methods to interact with it:

• GET Retrieve a specific object by ID or get a list of objects.
• POST Create a new object.
• PATCH Update attributes of a specific object.
• DELETE Remove a specific object.

We strive to keep our API predictable and consistent. However, different resources and objects may have different structures or fields based on their nature. Please refer to specific resource documentation for more detailed information.