API
The API is used to exchange data between WorkZeal services and external systems: your website, customer portal, accounting system, or your own application.
The API address is do.workzeal.com. Method descriptions with request examples in different languages are in the subsections: start with the quick start, then see the table of sections.
About the protocol
Access is based on the OData (Open Data Protocol) protocol, a standard designed specifically for querying and presenting data in APIs.
The examples in this documentation show useful OData capabilities but do not claim to be a complete description of the protocol. For that, refer to the OData specification.
Access token
The token is issued in the application: Settings → API. You need access rights to this section.
All issued tokens are stored in a registry, and any of them can be turned off. Traffic using that token stops immediately.
The token is passed in the request as a header:
Authorization: Bearer XXXXXXX.XXXXXXX.XXXXXXX
Content-Type: application/json
A convenient way to verify the setup is the request GET https://do.workzeal.com/welcome/. The response is the standard object with a status.
What is available
| Section | What it can do |
|---|---|
| Clients | Companies and individuals: list, add, update, card with company details |
| Contacts | Contact persons with their phones and emails: list, add, update |
| Deals | List, add, update, line items |
| Tasks | List, add, update, and close with a result |
| Documents | Invoices, contracts, and other documents: list, add, update, line items |
| Finance | Cash flow transactions: list, add, update |
| Warehouse | Products and services in the catalog: list, add, update |
| List of messages, send, mail accounts | |
| Users | List of active employees |
| Key metrics | Results of the day, the user's tasks, KPI progress for the user and their colleagues |
| Filters | Public filters and filters created by the token owner |
| Custom fields | Your custom fields by module |
| Directories | Directory values for clients and deals |
Things to keep in mind
- Responses are returned in JSON only: XML and ATOM formats are not supported.
- The OData service fields
__metadataand__deferredare not returned. - Data is returned according to the token owner's rights: the list contains exactly what that employee sees in the application. So think through the access rights level of the technical account in advance.