API activation and principles | Alma Career API docs

API activation

The export interface is created by the Teamio Support team upon the client’s request as a unique API endpoint for their company’s Teamio account. The request can be send directly from Teamio interface by the user as described on this Teamio Help page (in Czech). The Replies Export API is an unpaid service.

Before we make the API available, we need specification which IP addresses the destination system will use for requesting candidate replies. These addresses will then be whitelisted, and only requests from them will be successful.

Once the IP whitelist is set, we activate the replies export and provide the API endpoint URL along with access credentials (login and password).

IP Whitelist Limitation: We can whitelist up to 7 IP addresses, 3 IP ranges, or a combination where two IP addresses can be replaced by one range (for example, 3 IP addresses and 2 ranges).

Key principles of candidate export

Once this API for the client’s Teamio account is active, all new candidate replies to that company’s job ads will be automatically exported and accessible via the API in XML format.

Candidate replies submitted before the API activation date were not exported and therefore cannot be provided through it. For a one-time export of all historical candidate replies from the company’s Teamio account, the Ad-hoc Candidate Export service can be used.

Data included in the export:

All information provided by the candidate through the application questionnaire
All attachments added to the reply
Vacancy and candidate metadata from Teamio

The available candidate replies can then be regularly transferred to any system that is capable of sending requests to this API and processing the provided XML data. This part of the integration must always be handled by the destination system or its provider. Teamio cannot assist with development as we do not have access to the destination system and are not familiar with its technical setup.

Teamio is not technically capable of pushing exported candidate replies to external APIs. Candidate replies must always be retrieved from our API by the destination system or transferred through middleware that is compatible with it.