Set up R/W REST API

With our powerful REST API you can read and write data from and to onlyfy one Application Manager by using simple HTTPS requests. Read this article to learn how to set up the feature.

Important information for existing customers! On September 9, 2022 Prescreen moved to onlyfy.io. The domains end with onlyfy.io and onlyfy.jobs respectively. These domains will be redirected automatically, so you do not need to change them now. Not affected by the changeover is the domain https://api.prescreenapp.io. This currently remains unchanged. Until further notice, please continue to use the domain https://api.prescreenapp.io for REST-API calls.

How do I set up the R/W REST API?

The first step is to request the activation of the API function in your account from our Customer Service Team.

[hint]

Are you working on behalf of one of our customers?

Please ask your customer to generate an API key for you in their onlyfy one Application Manager account. Due to data protection we only grant API access to existing users of Application Manager and their respective accounts.

[/hint]

Once you have received the access, go to "Settings" (1) > "Integrations" (2) > "Rest API" (3) and klick on the "Create new API key" (4) in order to create a new API key.

Set up the API key access rights. Make sure to restrict access to sensitive data (like account user management) in cases when it's required.

[hint]

Take a look at our API documentation.

[/hint]

[tip]

Take advantage of our test interface: On the top right of the page you can enter your API key and send requests and inspect the response..

[/tip]