Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: CoderPad Screen Tests API
description: 'Documentation for the CoderPad Screen API (formerly known as CodinGame for Work)
# Version
This is the documentation for version v1.1 of the API which is the latest version available.
API version will be incremented for any breaking changes.
WARNING: over time, new fields may be added to the responses JSON objects for this version of the API.
This does not constitute a breaking change and the version of the API will NOT be incremented.
Please, make sure your deserialization code does not break when a new field is added to a response JSON object.
# Authentication
An API key must be declared in the http headers of each request. The name of the header parameter is `API-Key`.
If the API key is invalid, the request will produce a **401** error.
Once you have received your API key, you can pass it in the header of the requests, for instance:
```bash
curl --header "API-Key: your_api_key" \
--request GET \
https://screen.coderpad.io/assessment/api/v1.1/campaigns
```
## API Key Access
To access your CoderPad Screen API key, simply click on **ACCOUNT** in the top navigation menu, and then select **Integration**. You''ll then be presented with the following page:
!CoderPad API Key screenshot
Then click **Generate key** to create a key that you can then copy and use in your desired integration.
# Errors
The API uses standard HTTP status codes to indicate the success or failure of the API call.
The body of the response will be JSON in the following format:
```
{
"code": "specific code for the error",
"message": "explanatory message"
}
```
Error codes can be `InvalidTestId`, `NotFoundTestId`, `InvalidCampaignId`, `BadCandidateEmailFormat`, `BadRecruiterEmailFormat`, `CandidateNameTooLong`,
`InvalidCampaignPayload`, `InvalidLocale`, `NotFoundQuestionId`, `NotFoundDomain`, `NotFoundTeam`, `FeatureNotAvailable`, `TestNotFinished`
depending on the request.
The error `code` is required while the `message` is optional.'
contact:
email: support@coderpad.io
version: v1.1
servers:
- url: https://screen.coderpad.io/assessment/api
description: CoderPad Screen US
- url: https://www.codingame.eu/assessment/api
description: CoderPad Screen EU
security:
- ApiKeyAuth: []
tags:
# --- truncated at 32 KB (111 KB total) ---
# Full source: https://artifacts.apis.io/coderpad/openapi/coderpad-tests-api-openapi.yml