Request and Response Structure

Zoho WorkDrive's APIs follow JSON:API specification, which is a powerful method of communication between client and server with well-structured request and response formatting. Besides responses, JSON:API also covers creating, updating, and deleting resources and offers features like filtering, pagination, sparse field sets, great error formatting, etc. Click here to learn more about JSON API specifications. As mentioned, all entities are exposed as JSON:API resources using the structure as follows:

{
  "data": [
    {
      "type": "type",
      "id": "identifier",
      "attributes": "{....}",
      "relationships": "{....}"
    }
  ],
  "links": "{....}",
  "meta": "{....}"
}

JSON:API responses are composed inside the "data" key. This "data" key consists of five sections:

• Identifier keys: These identify the "type" and "ID" of an entity. These two keys uniquely identify the entity.
• attributes: This describes actual entity properties such as name, kind, created time, etc.
• relationships: This describes relationships between the current entity and other entities within WorkDrive.
• links: This is used to access related entities.
• meta: This provides additional information about entities to support meaningful interactions with the end-user.