CoderPad Pad environments API

openapi: 3.2.0
info:
  title: CoderPad Interview Pad environments API
  version: 1.0.0
  description: 'The CoderPad Interview API lets you create and manage interview pads and questions programmatically, for example to integrate CoderPad with your interview scheduling platform or to retrieve the content of an interview once it has ended.


    It is a REST API that returns JSON.


    # Authentication


    Every request is authenticated with your API key, which you can find on your settings page. Send it in the `Authorization` header, either as a bearer token or in the `Token` format:


    ```

    curl -H ''Authorization: Bearer YOUR_API_KEY'' https://app.coderpad.io/api/pads

    curl -H ''Authorization: Token token="YOUR_API_KEY"'' https://app.coderpad.io/api/pads

    ```


    # Responses and errors


    Every response is a JSON object. Successful responses have an HTTP 2xx status and include `"status": "OK"`. Unsuccessful responses have an appropriate HTTP status and include `"status": "ERROR"` and a human-readable `message`:


    ```json

    { "status": "ERROR", "message": "Invalid API key" }

    ```


    | HTTP status | Meaning |

    | --- | --- |

    | 200 | The request succeeded. |

    | 400 | The request is invalid, for example because it specifies a language that does not exist. |

    | 401 | The API key is not tied to a valid account, or you cannot access this resource. |

    | 403 | You do not have permission to perform this action. |

    | 404 | The resource does not exist or is not visible to you. |

    | 429 | Too many requests, or your pad quota is exhausted. |


    # Request bodies


    Requests can be sent as JSON or as form data. Write endpoints expect their fields wrapped in an object named after the resource (`{"pad": {"title": "..."}}`, `question[title]=...`), but also accept them at the top level (`{"title": "..."}`, `title=...`).


    # Pagination


    List endpoints return at most 50 items per request, along with a `total` count. Follow the `next_page` and `prev_page` URLs, when present, to fetch the other pages.


    # Languages


    Wherever a request or response has a `language` field, its value is a CoderPad language key such as `python3`, `javascript`, `typescript`, `java`, `ruby`, `go`, `csharp`, `cpp` or `postgresql`. Where noted, project template slugs (multi-file environments such as `react` or `multifile_python`) are also accepted.'
  contact:
    name: CoderPad Support
    url: https://coderpad.io/support/
servers:
- url: https://app.coderpad.io/api
security:
- apiKey: []
tags:
- name: Pad environments
  description: The language environments of a pad, including their files.
paths:
  /pad_environments/{id}:
    get:
      tags:
      - Pad environments
      operationId: getPadEnvironment
      summary: Retrieve a pad environment
      description: Returns a pad environment and the current contents of its files. The IDs of a pad's environments are listed in its `pad_environment_ids`.
      parameters:
      - name: id
        in: path
        required: true
        description: The pad environment ID.
        schema:
          type: integer
      responses:
        '200':
          description: The pad environment.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Ok'
                - $ref: '#/components/schemas/PadEnvironment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    PadEnvironment:
      type: object
      properties:
        id:
          type: integer
        pad_id:
          type: integer
        question_id:
          type:
          - integer
          - 'null'
        example_question_id:
          type:
          - string
          - 'null'
        language:
          type: string
          description: The language key or project template slug of the environment, `spreadsheet`, or `unknown` when it cannot be determined.
        file_contents:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              contents:
                type: string
              history:
                type: string
                format: uri
                description: URL of the raw edit history of the file.
        created_at:
          $ref: '#/components/schemas/Timestamp'
        updated_at:
          $ref: '#/components/schemas/Timestamp'
    Ok:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          enum:
          - OK
    Error:
      type: object
      required:
      - status
      - message
      properties:
        status:
          type: string
          enum:
          - ERROR
        message:
          type: string
          description: A human-readable description of the error.
    Timestamp:
      type: string
      format: date-time
      example: '2026-09-30T14:02:11Z'
  responses:
    NotFound:
      description: The resource does not exist or is not visible to you.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: ERROR
            message: Pad not found
    Unauthorized:
      description: The API key is invalid, or you cannot access this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: ERROR
            message: Invalid API key
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'Your API key, from [your settings page](https://app.coderpad.io/settings). The `Authorization: Token token="YOUR_API_KEY"` format is also accepted.

        '
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/createpad.md
  - https://developers.coderpad.io/reference/createquestion-1.md
  - https://developers.coderpad.io/reference/createquestionvariant.md
  - https://developers.coderpad.io/reference/deletequestion.md
  - https://developers.coderpad.io/reference/deletequestionvariant.md
  - https://developers.coderpad.io/reference/getorganization.md
  - https://developers.coderpad.io/reference/getorganizationstats.md
  - https://developers.coderpad.io/reference/getpad.md
  - https://developers.coderpad.io/reference/getpadenvironment.md
  - https://developers.coderpad.io/reference/getquestion.md
  - https://developers.coderpad.io/reference/getquestionvariant.md
  - https://developers.coderpad.io/reference/getquota.md
  - https://developers.coderpad.io/reference/getuser.md
  - https://developers.coderpad.io/reference/listorganizationpads.md
  - https://developers.coderpad.io/reference/listorganizationquestions.md
  - https://developers.coderpad.io/reference/listorganizationusers.md
  - https://developers.coderpad.io/reference/listpadevents.md
  - https://developers.coderpad.io/reference/listpads.md
  - https://developers.coderpad.io/reference/listquestions.md
  - https://developers.coderpad.io/reference/listquestionvariants.md
  - https://developers.coderpad.io/reference/updatepad.md
  - https://developers.coderpad.io/reference/updatequestion-1.md
  - https://developers.coderpad.io/reference/updatequestionvariant.md
  merge:
    pages: 23
    deduped: 211
    conflicts_kept_first: 0