CoderPad Me API

openapi: 3.2.0
info:
  title: CoderPad Screen Me 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:
- name: Me
paths:
  /v1.1/me:
    get:
      tags:
      - Me
      summary: Get information about the owner of the token
      operationId: me
      responses:
        '200':
          description: Return the information about token's owner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/me'
components:
  schemas:
    me_team:
      type: object
      properties:
        id:
          type: string
          description: the team id
          example: 0558b3e3-b76c-42ea-9435-8da1adb7e232
        name:
          type: string
          description: the team name
          example: Engineering
        is_default:
          type: boolean
          description: whether the team is the default one of the token owner
          example: true
      description: a team the account is a member of
    me:
      type: object
      properties:
        teams:
          type: array
          description: the teams the account is a member of
          items:
            $ref: '#/components/schemas/me_team'
        organization_id:
          type: string
          description: the organization id
          example: 0558b3e3-b76c-42ea-9435-8da1adb7e232
        recruiter_id:
          type: string
          description: the recruiter id
          example: 0558b3e3-b76c-42ea-9435-8da1adb7e232
      description: description of the account that own the token
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: API-Key
      in: header
x-provenance:
  method: searched
  source: https://developers.coderpad.io/reference
  harvested: '2026-10-27'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.coderpad.io/reference/aiassistconversations.md
  - https://developers.coderpad.io/reference/campaign.md
  - https://developers.coderpad.io/reference/campaigninsights.md
  - https://developers.coderpad.io/reference/campaigns-1.md
  - https://developers.coderpad.io/reference/cancel.md
  - https://developers.coderpad.io/reference/candidateproject.md
  - https://developers.coderpad.io/reference/createcampaign.md
  - https://developers.coderpad.io/reference/createquestion.md
  - https://developers.coderpad.io/reference/delete.md
  - https://developers.coderpad.io/reference/getwebhook.md
  - https://developers.coderpad.io/reference/me-1.md
  - https://developers.coderpad.io/reference/playbackevents.md
  - https://developers.coderpad.io/reference/question.md
  - https://developers.coderpad.io/reference/questioninsights.md
  - https://developers.coderpad.io/reference/questions-2.md
  - https://developers.coderpad.io/reference/report.md
  - https://developers.coderpad.io/reference/resend.md
  - https://developers.coderpad.io/reference/send.md
  - https://developers.coderpad.io/reference/subscribe.md
  - https://developers.coderpad.io/reference/testsstatus.md
  - https://developers.coderpad.io/reference/teststatus.md
  - https://developers.coderpad.io/reference/unsubscribe.md
  - https://developers.coderpad.io/reference/updatequestion.md
  - https://developers.coderpad.io/reference/upload.md
  merge:
    pages: 24
    deduped: 122
    conflicts_kept_first: 0