{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-apis/public/integration-api.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"apis/public/integration-api.yaml","dynamicMarkdocComponents":[],"baseSlug":"/apis/public/integration-api","seo":{"title":"Clearspeed Integration API","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Clearspeed Integration API","description":"## Overview\nThe Clearspeed Integration API enables you to programmatically manage participants\nwithin your questionnaires — create new participants, initiate retakes, and update\noutcome tracking. Additionally, Clearspeed delivers assessment results directly to\nyour system via webhooks, eliminating the need to poll for results.\n\n## Authentication\nAll requests must include your API key in the `Authorization` header:\n```\nAuthorization: <your-api-key>\n```\n\nAPI keys are scoped to a specific questionnaire and carry explicit permissions.\nYour first key must be created from the Clearspeed web application by a questionnaire Admin.\nOnce you have a key with the `apikey:write` scope you can create additional keys via the API.\n\nSee the [API Keys & Authentication guide](https://docs.clearspeed.com/api-keys) for a\nstep-by-step walkthrough and a full description of all available scopes.\n\n## Environments\n| Region | Base URL |\n|--------|----------|\n| US Production | `https://api.us.clearspeed.com/questionnaire/v1` |\n| UK Production | `https://api.uk.clearspeed.com/questionnaire/v1` |\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"developer.clearspeed.com","port":4000,"ipAddress":"216.73.216.5"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/apis/public/integration-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}