CoderPad · Schema

CreateCampaignRequest

the test to create

CompanyArtificial IntelligenceHiringTechnical AssessmentInterviewPlatform

Properties

Name Type Description
name string the test name, between 3 and 64 characters
questions array the test entries, in the order candidates take them
settings object
team_id string the team the test belongs to, one of the teams GET /v1.1/me returns. Defaults to the default team of the token owner
View JSON Schema on GitHub

JSON Schema

coderpad-create-campaign-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/coderpad/json-schema/coderpad-create-campaign-request-schema.json",
  "title": "CreateCampaignRequest",
  "description": "the test to create",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/coderpad-campaigns-api-openapi.yml#/components/schemas/CreateCampaignRequest",
  "required": [
    "name",
    "questions"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "the test name, between 3 and 64 characters"
    },
    "questions": {
      "minItems": 1,
      "type": "array",
      "description": "the test entries, in the order candidates take them",
      "items": {
        "$ref": "#/$defs/campaign_question"
      }
    },
    "settings": {
      "$ref": "#/$defs/campaign_settings"
    },
    "team_id": {
      "type": "string",
      "description": "the team the test belongs to, one of the teams GET /v1.1/me returns. Defaults to the default team of the token owner",
      "format": "uuid"
    }
  },
  "$defs": {
    "campaign_access_period": {
      "type": "object",
      "properties": {
        "min_start_time": {
          "type": "string",
          "description": "ISO 8601 instant before which candidates cannot start the test"
        },
        "max_end_time": {
          "type": "string",
          "description": "ISO 8601 instant after which candidates cannot take the test anymore, after min_start_time. Only a GLOBAL or UNLIMITED timer accepts one: each question of a PER_QUESTION timed test starts its own timer"
        }
      },
      "description": "when candidates are allowed to take the test"
    },
    "campaign_follow_up_questions": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "whether follow-up questions are asked, which only a PER_QUESTION timer allows"
        },
        "answer_format": {
          "type": "string",
          "description": "how candidates answer the follow-up questions",
          "enum": [
            "TEXT",
            "VIDEO",
            "AUDIO"
          ]
        }
      },
      "description": "asking candidates to justify their answers after a coding exercise"
    },
    "campaign_question": {
      "required": [
        "type"
      ],
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "whether the entry is a single question or a set drawn at random",
          "enum": [
            "QUESTION",
            "RANDOM_QUESTION_SET"
          ]
        },
        "configuration": {
          "$ref": "#/$defs/random_question_set_configuration"
        },
        "question_id": {
          "type": "string",
          "description": "the question to add, required on a QUESTION entry",
          "format": "uuid"
        }
      },
      "description": "one entry of the test, in the order candidates take them"
    },
    "campaign_settings": {
      "type": "object",
      "properties": {
        "languages": {
          "type": "array",
          "description": "the locales the test is available in, among the locales enabled on the account",
          "items": {
            "type": "string",
            "description": "the locales the test is available in, among the locales enabled on the account"
          }
        },
        "timer": {
          "$ref": "#/$defs/campaign_timer"
        },
        "invitation_expiration_days": {
          "type": "integer",
          "description": "how many days a candidate has to start the test after being invited",
          "format": "int32"
        },
        "access_period": {
          "$ref": "#/$defs/campaign_access_period"
        },
        "send_candidate_simplified_report": {
          "type": "boolean",
          "description": "whether candidates receive a simplified report once they submit the test"
        },
        "copy_paste_blocked": {
          "type": "boolean",
          "description": "whether candidates are prevented from copying and pasting"
        },
        "follow_up_questions": {
          "$ref": "#/$defs/campaign_follow_up_questions"
        },
        "webcam_proctoring": {
          "$ref": "#/$defs/campaign_webcam_proctoring"
        },
        "full_screen_required": {
          "type": "boolean",
          "description": "whether candidates must keep the test in full screen"
        },
        "ai_assist_enabled": {
          "type": "boolean",
          "description": "whether candidates have access to the AI assistant in project questions"
        },
        "enabled_coding_agents": {
          "type": "string",
          "description": "the coding agents candidates may run, none when empty",
          "enum": [
            "CLAUDE_CODE",
            "CODEX"
          ]
        }
      },
      "description": "how the test behaves, defaulting to the settings of the team it belongs to"
    },
    "campaign_timer": {
      "type": "object",
      "properties": {
        "mode": {
          "type": "string",
          "description": "how the test times the candidate",
          "enum": [
            "PER_QUESTION",
            "GLOBAL",
            "UNLIMITED"
          ]
        },
        "duration_minutes": {
          "type": "integer",
          "description": "how long the whole test lasts, required in GLOBAL mode and rejected in the other two",
          "format": "int32"
        }
      },
      "description": "how the test times the candidate"
    },
    "campaign_webcam_proctoring": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "whether candidates are recorded through their webcam"
        },
        "ai_analysis_enabled": {
          "type": "boolean",
          "description": "whether the webcam snapshots are analyzed by AI"
        }
      },
      "description": "recording candidates via their webcam while they take the test"
    },
    "random_question_set_configuration": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "description": "the domain the questions are drawn from, among the domains the account holds questions in"
        },
        "skills": {
          "type": "array",
          "description": "the skills the questions must cover, among the skills the questions of the domain carry",
          "items": {
            "type": "string",
            "description": "the skills the questions must cover, among the skills the questions of the domain carry"
          }
        },
        "question_type": {
          "type": "string",
          "description": "the kind of question drawn",
          "enum": [
            "QUIZ",
            "CODE"
          ]
        },
        "target_duration_minutes": {
          "type": "integer",
          "description": "how long the drawn questions should last altogether, the draw approaches it without matching it exactly. 5, 10, 15, 20, 25 or 30 for a QUIZ set, 5, 10, 20, 30, 45 or 60 for a CODE one",
          "format": "int32"
        },
        "target_experience_level": {
          "type": "string",
          "description": "the experience level the questions target, SENIOR when left out",
          "enum": [
            "JUNIOR",
            "SENIOR",
            "EXPERT"
          ]
        },
        "included_question_ids": {
          "type": "array",
          "description": "the only questions the set may draw, which also means questions added later are never drawn. Each of them must be a question of the kind and of the domain the set draws. Mutually exclusive with excluded_question_ids",
          "items": {
            "type": "string",
            "description": "the only questions the set may draw, which also means questions added later are never drawn. Each of them must be a question of the kind and of the domain the set draws. Mutually exclusive with excluded_question_ids",
            "format": "uuid"
          }
        },
        "excluded_question_ids": {
          "type": "array",
          "description": "the questions the set must never draw, which also means questions added later are drawn. Each of them must be a question of the kind and of the domain the set draws. Mutually exclusive with included_question_ids",
          "items": {
            "type": "string",
            "description": "the questions the set must never draw, which also means questions added later are drawn. Each of them must be a question of the kind and of the domain the set draws. Mutually exclusive with included_question_ids",
            "format": "uuid"
          }
        }
      },
      "description": "which questions a random set may draw"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/coderpad-create-campaign-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

A second provider on the same verified email joins the account you already have.