# Welcome!

The API is designed for exchanging data between WorkZeal services and external clients.&#x20;

The API is accessed via the Open Data Protocol. OData is a standardized protocol specifically designed for use in API systems. The examples provided in the description illustrate some useful OData capabilities for retrieving and presenting data, but these examples alone are not sufficient for a full understanding of OData principles.&#x20;

In most cases, the WorkZeal API complies with the OData protocol, with the following exceptions:&#x20;

Data output is only in JSON format; XML and ATOM formats are not supported;&#x20;

Metadata ("\_\_metadata") and related entity ("\_\_deferred") fields are not output;


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidoc.workzeal.com/welcome.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
