1. Overview
Welcome to the Screenloop API documentation. This API allows developers to connect and interact with your ATS data, your way. Providing access to:
Applications, Candidates, Jobs, Interviews, Interview kits, Scorecard templates, Offers, Job and Interview Stages, Locations, Members, and Reject reasons.
2. Getting Started
The following steps will guide you on how to obtain your API Key from Screenloop.
Who can generate an API key? Admin only
Once logged into your Screenloop account:
Navigate to Settings > API Keys.
Select Generate API Key in the top right.
Fill the Key Name field with your chosen name.
Click Generate.
Copy the key to your clipboard.
This is the only time your API key will be visible. Copy it to your clipboard and store it in a secure location. You won’t be able to view it again.
For additional details on creating, editing and revoking API keys, please consult our API Key Management documentation.
3. API calls
The Screenloop API is a RESTful API with different endpoints which return JSON data for - Applications, Candidates, Jobs, Interviews, Interview kits, Scorecard templates, Offers, Job and Interview Stages, Locations, Members and Reject reasons.
3.1 Base URL
The base address of our API is https://api.screenloop.com/
3.2 Making a request
You can explore and interact with our API directly through our Swagger documentation. It provides a user-friendly interface to test endpoints, view request/response formats, and understand available parameters.
For next steps, developers will be able to plug into your organisation’s data tools, such as BI dashboards or internal analytics systems. Be sure to consult your chosen tools' documentation for guidance on integration.
3.3 Rate Limit
The rate limit for Screenloop’s API is limited to 6 requests per second.
If your app makes a lot of API requests in a short period of time, then it may receive an error response from Screenloop. This indicates that you have reached our rate limit. These rate limits are put in place in order to keep our API reliable for all users and ensure the API is used in a responsible way.