UZIO offers a comprehensive collection of REST APIs that enable you to build integrations with UZIO's system for various use cases. This document provides all the necessary information to effectively use the APIs.

Authentication

Our APIs are secured using HTTP Basic authentication. Click here to learn more about this authentication method.
To initiate an API request, you must first generate an API Key as explained below. Once you have generated your API Key, use it as the username in the authorization header when making API calls. It is not necessary to include a password in the authorization header, but you can enter any random value if required.
Please note that the API Key serves as a unique identifier for the user within our system. Therefore, it is essential to keep the API Key in a secure location with limited accessibility to maintain data confidentiality and prevent unauthorized access. We recommend storing the API Key in an encrypted format and restricting access to authorized personnel only.
When a valid API Key is used, the system verifies the key and identifies the associated company(s) for which key is generated and sends the response accordingly.

An example curl request might look like this:

curl -X 'GET' \
  'https://api.uzio.com/api/payroll/ext/getJobsFromJobsMaster' \
  -H 'companyId: 3a532405-a1dc-4ed8-933f-231dfd9a7f8b' \
  --user key:random_password

How to Generate an API Key

An employer administrator only can generate the API Key. If you are an employer administrator and would like to generate the API Key, you can generate the same by visiting the API Keys page, which is available under the "Profile Menu" at the employer portal. From there you can generate single or multiple API keys as per your requirement.

If you have any questions or concerns, please reach out to our support team at support@uzio.com for assistance.

Company Identifier

We support both single and multiple linked company structures on our platform, which makes it imperative to share the company identifier(companyID) along with the API Key for most API calls. It helps to ensure that API requests are directed to the appropriate company, and the data fetched pertains only to that company.

If you have any questions or concerns, please reach out to our support team at support@uzio.com for assistance.

How to Get Company Identifier

Once you have the API Key for your company, You can call the "Get Company Details" API which will return you company identifier (companyID) for your company and linked companies if any.

Pagination

For faster response, UZIO supports pagination for specific APIs. To use pagination, page and size parameters need to be sent as request parameters as shown in an example below:

https://api.uzio.com/api/organization/kb/getAllEmployees/true?page=1&size=2

In the this example, the page is the page number, and size parameter is the number of records to be sent in each request.

Pagination metadata is included in the API response header wherever it is applicable.

Header	Description	Example
X-Per-Page	Number of records currently being returned per page. Same as the 'size' parameter in the request.	25
X-Total-Count	The total number of records matching the request parameters.	343
X-Total-Pages	Total number of pages for the request. Roughly (X-Total-Count / X-Per-Page).	15
X-Page	The current page being returned.	5

Time Zone

Our API supports time zones for time tracking related functionalities. The default timezone would be the employee's current work location's timezone. However, users have the flexibility to specify their desired time zone like, GMT-05:00. This ensures accurate and localized time tracking, accommodating regional requirements and individual preferences. Please click here to see the list of system supported time zones. With our time zone support, users can accurately record timestamps.

Additional Notes:

APIs communication will happen over HTTPS. APIs support JSON format.
If an unknown API Key is used repeatedly, UZIO will disable access for a period. Users still will be able to log in to the UZIO platform with their credentials during this time. When the API is disabled, it will send back an HTTP 403 Forbidden response to any requests it receives.
To serve our customers better, We will be rate-limiting the requests if their run-rate exceeds the threshold.
For invalid requests we will send specific HTTP error codes and corresponding detailed messages.

API List

Below is the list of currently supported APIs.

Note: You can try out these APIs from this page itself. Please follow the following steps:

Click on the lock icon next to the API name. On the Authorize popup provide your API Key, password can be blank and click on "Authorize" button and close the popup.
Click on the "Try it out" button.
Provide necessary parameters and hit the "Execute" button.