ZenATS Public APIs User Manual

Overview

ZenATS Public APIs allow you to connect ZenATS with external systems and applications, such as ERP systems, and to build custom careers pages using your ZenATS recruitment data.

Availability: Public APIs are available only for customers on the ZenATS Advanced tier.

For full technical details, including available endpoints, permissions, and examples, refer to the API Reference available from the Public APIs page.

1. Access the Public APIs Page

To access the Public APIs:

1. Log in to ZenATS.

2. Go to System Preferences.

3. Select Public APIs from the Settings menu.

From this page, you can create and manage API clients.

2. Create a New API Client

To generate API credentials:

1. Click New client.

2. Enter a name that helps you identify the integration, such as:

   • ERP Integration

   • Careers Website

3. Select the permissions required by the integration.

4. Create the client.

Once the client is created, ZenATS generates the credentials required to authenticate through the API.

3. Copy and Store the Client Secret

Immediately after creating the API client, ZenATS displays the Client Secret.

Important: The Client Secret is shown only once.

You must copy the Client Secret and store it securely as soon as it appears.

After you leave or refresh the page, the secret disappears and cannot be retrieved again.

If the Client Secret is lost, you will need to revoke or replace the credentials and generate new ones.

Do not share the Client Secret publicly or store it in unsecured documents or communication channels.

4. Client ID

Each API client also has a unique Client ID.

Unlike the Client Secret, the Client ID remains visible on the Public APIs page and can be referenced later when configuring the integration.

The Client ID and Client Secret are used to obtain an access token for API authentication.

5. API Permissions

Each API client is assigned specific permissions that control what the connected system can access or modify.

Available permissions can include actions related to:

• Candidates

• Jobs

• Job Candidates / Applications

• Recruitment Stages

• Moving candidates between stages

• Qualifying candidates

• Disqualifying candidates

Only grant the permissions required by the integration.

For example, a careers website that only displays available jobs may require fewer permissions than an ERP integration that needs to read and update recruitment information.

6. Manage Existing API Clients

Created API clients appear on the Public APIs page along with their:

• Name

• Client ID

• Permissions

• Creation date

From this page, you can also manage access to an existing client.

Revoke Tokens

Select Revoke tokens when you want to invalidate the access tokens associated with an API client.

This can be useful if credentials may have been compromised or access needs to be reset.

Delete Client

Select Delete when the API client is no longer required.

Deleting a client removes its API access.

7. API Documentation

For implementation details, select API Reference from the Public APIs page.

The API documentation contains the available endpoints, scopes, authentication details, and request examples.

ZenATS Public APIs currently cover core recruitment resources such as:

• Candidates

• Jobs

• Job Candidates / Applications

• Recruitment Stages

They can be used to support integrations with ERP and other business systems, as well as custom careers pages and other recruitment-related integrations.

Security Recommendation

Treat the Client ID and especially the Client Secret as sensitive credentials.

The Client Secret should be stored securely by the technical team implementing the integration and should never be exposed in public source code, browser-side code, shared documents, or other unsecured locations.