{"items":[{"type":"link","label":"Clearspeed Integration API","link":"/apis/public/integration-api","routeSlug":"/apis/public/integration-api","content":{"contentType":"overview","meta":{"name":"Clearspeed Integration API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"integration-api.json","url":"/_bundle/apis/public/integration-api.json?download"},{"kind":"download","label":"integration-api.yaml","url":"/_bundle/apis/public/integration-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Clearspeed Integration API","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/apis/public/integration-api"}],"sectionId":"/apis/public/integration-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Clearspeed Integration API enables you to programmatically manage participants"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"within your questionnaires — create new participants and update"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outcome tracking. Additionally, Clearspeed delivers assessment results directly to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your system via webhooks, eliminating the need to poll for results."},"children":[]}]}]}]}],"sectionId":"/apis/public/integration-api/section/overview"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All requests must include your API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: <your-api-key>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: <your-api-key>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API keys are scoped to a specific questionnaire and carry explicit permissions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your first key must be created from the Clearspeed web application by a questionnaire Admin."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have a key with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apikey:write"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope you can create additional keys via the API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.clearspeed.com/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys & Authentication guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"step-by-step walkthrough and a full description of all available scopes."},"children":[]}]}]}]}],"sectionId":"/apis/public/integration-api/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.us.clearspeed.com/questionnaire"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UK Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.uk.clearspeed.com/questionnaire"},"children":[]}]}]}]}]}]}]}],"sectionId":"/apis/public/integration-api/section/environments"}]}]}},{"type":"link","label":"Overview","link":"/apis/public/integration-api/section/overview","routeSlug":"/apis/public/integration-api/section/overview","content":null},{"type":"link","label":"Authentication","link":"/apis/public/integration-api/section/authentication","routeSlug":"/apis/public/integration-api/section/authentication","content":null},{"type":"link","label":"Environments","link":"/apis/public/integration-api/section/environments","routeSlug":"/apis/public/integration-api/section/environments","content":null},{"label":"Participant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public/integration-api/paths/~1v1~1participant/post","routeSlug":"/apis/public/integration-api/paths/~1v1~1participant/post","metadata":{"seo":{"title":"Participant","description":"Creates a new participant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Participant","isWebhook":false,"pointer":"/paths/~1v1~1participant/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Participant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new participant."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retake: To allow a participant to retake an unsuccessfully completed questionnaire, provide the existing participant's participant_uuid. This is only supported for participants who did not successfully complete the questionnaire."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44","exampleIds":["paths/~1v1~1participant/post/requestBody/content/application~1json/examples/create"]}},"schemaId":"schema_44","exampleIds":["paths/~1v1~1participant/post/requestBody/content/application~1json/examples/create"],"pointer":"/paths/~1v1~1participant/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/participant","servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_44","exampleIds":["paths/~1v1~1participant/post/requestBody/content/application~1json/examples/create"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/participant","href":"paths/~1v1~1participant/post","summary":"Participant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"schemaId":"schema_44","exampleIds":["paths/~1v1~1participant/post/requestBody/content/application~1json/examples/create"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44","exampleIds":["paths/~1v1~1participant/post/requestBody/content/application~1json/examples/create"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Participant created, or — on a retake — the participant named by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"participant_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Both modes return the same body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyParticipantResponse","exampleIds":["paths/~1v1~1participant/post/responses/200/content/application~1json/examples/participantResponse"]}},"schemaId":"components/schemas/LegacyParticipantResponse","exampleIds":["paths/~1v1~1participant/post/responses/200/content/application~1json/examples/participantResponse"]},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/400/content/application~1json/examples/badRequest","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/projectUUIDRequired","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/irnCannotBeEmpty","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidProjectUUIDFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidParticipantUUIDFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidEmailFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/duplicateIRN"]}},"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/400/content/application~1json/examples/badRequest","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/projectUUIDRequired","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/irnCannotBeEmpty","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidProjectUUIDFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidParticipantUUIDFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidEmailFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/duplicateIRN"]},{"code":"401","description":"Missing or invalid API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/401/content/application~1json/examples/unauthorized","paths/~1v1~1participant/post/responses/401/content/application~1json/examples/invalidAPIKey"]}},"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/401/content/application~1json/examples/unauthorized","paths/~1v1~1participant/post/responses/401/content/application~1json/examples/invalidAPIKey"]},{"code":"403","description":"API key is not associated with the participant's questionnaire tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Participant not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/404/content/application~1json/examples/notFound","paths/~1v1~1participant/post/responses/404/content/application~1json/examples/projectNotFound"]}},"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/404/content/application~1json/examples/notFound","paths/~1v1~1participant/post/responses/404/content/application~1json/examples/projectNotFound"]}],"pointer":"/paths/~1v1~1participant/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LegacyParticipantResponse","exampleIds":["paths/~1v1~1participant/post/responses/200/content/application~1json/examples/participantResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyParticipantResponse","exampleIds":["paths/~1v1~1participant/post/responses/200/content/application~1json/examples/participantResponse"]}}},{"code":"400","schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/400/content/application~1json/examples/badRequest","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/projectUUIDRequired","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/irnCannotBeEmpty","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidProjectUUIDFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidParticipantUUIDFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidEmailFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/duplicateIRN"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/400/content/application~1json/examples/badRequest","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/projectUUIDRequired","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/irnCannotBeEmpty","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidProjectUUIDFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidParticipantUUIDFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidEmailFormat","paths/~1v1~1participant/post/responses/400/content/application~1json/examples/duplicateIRN"]}}},{"code":"401","schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/401/content/application~1json/examples/unauthorized","paths/~1v1~1participant/post/responses/401/content/application~1json/examples/invalidAPIKey"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/401/content/application~1json/examples/unauthorized","paths/~1v1~1participant/post/responses/401/content/application~1json/examples/invalidAPIKey"]}}},{"code":"403","schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/404/content/application~1json/examples/notFound","paths/~1v1~1participant/post/responses/404/content/application~1json/examples/projectNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyErrorResponse","exampleIds":["paths/~1v1~1participant/post/responses/404/content/application~1json/examples/notFound","paths/~1v1~1participant/post/responses/404/content/application~1json/examples/projectNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paths/~1v1~1participant/post"}],"panels":[]}]},"httpPath":"/v1/participant"},{"label":"Outcome Tracking","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public/integration-api/paths/~1v1~1participant~1{participant_id}/put","routeSlug":"/apis/public/integration-api/paths/~1v1~1participant~1{participant_id}/put","metadata":{"seo":{"title":"Outcome Tracking","description":"Update the outcome tracking fields for an existing participant using the v1 external API format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Outcome Tracking","isWebhook":false,"pointer":"/paths/~1v1~1participant~1{participant_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Outcome Tracking","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outcome tracking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields for an existing participant using the v1 external API format."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticated using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates that the API key is associated with the participant's questionnaire tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the participant's outcome and optional outcome timestamp."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"participant_id","in":"path","schemaId":"schema_45","description":"UUID of the participant whose outcome tracking should be updated","required":true}],"pointer":"/paths/~1v1~1participant~1{participant_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/requestBody/content/application~1json/examples/updateOutcome"]}},"schemaId":"schema_46","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/requestBody/content/application~1json/examples/updateOutcome"],"pointer":"/paths/~1v1~1participant~1{participant_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/participant/{participant_id}","servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"parameters":{"path":[{"name":"participant_id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/requestBody/content/application~1json/examples/updateOutcome"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/participant/{participant_id}","href":"paths/~1v1~1participant~1{participant_id}/put","summary":"Outcome Tracking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"schemaId":"schema_46","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/requestBody/content/application~1json/examples/updateOutcome"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/requestBody/content/application~1json/examples/updateOutcome"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Outcome tracking updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingResponse"}},"schemaId":"components/schemas/OutcomeTrackingResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/badRequest","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidParticipantIdFormat","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidOutcomeTsFormat","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/failedToUpdateOutcomeTracking"]}},"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/badRequest","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidParticipantIdFormat","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidOutcomeTsFormat","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/failedToUpdateOutcomeTracking"]},{"code":"401","description":"Missing or invalid API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/unauthorized","paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/invalidAPIKey"]}},"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/unauthorized","paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/invalidAPIKey"]},{"code":"403","description":"API key is not associated with the participant's questionnaire tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Participant or questionnaire not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/notFound","paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/questionnaireNotFound"]}},"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/notFound","paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/questionnaireNotFound"]}],"pointer":"/paths/~1v1~1participant~1{participant_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OutcomeTrackingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingResponse"}}},{"code":"400","schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/badRequest","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidParticipantIdFormat","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidOutcomeTsFormat","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/failedToUpdateOutcomeTracking"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/badRequest","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidParticipantIdFormat","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidOutcomeTsFormat","paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/failedToUpdateOutcomeTracking"]}}},{"code":"401","schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/unauthorized","paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/invalidAPIKey"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/unauthorized","paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/invalidAPIKey"]}}},{"code":"403","schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/notFound","paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/questionnaireNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutcomeTrackingErrorResponse","exampleIds":["paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/notFound","paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/questionnaireNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paths/~1v1~1participant~1{participant_id}/put"}],"panels":[]}]},"httpPath":"/v1/participant/{participant_id}"},{"label":"API Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public/integration-api/other/createapikey","routeSlug":"/apis/public/integration-api/other/createapikey","metadata":{"seo":{"title":"API Key","description":"Create a new API key for the specified questionnaire."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApiKey","name":"API Key","isWebhook":false,"pointer":"/paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new API key for the specified questionnaire."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a key with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apikey:write"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope. The full key value is returned "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — store it securely immediately. Subsequent list calls return a masked version."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenant_id","in":"path","schemaId":"schema_45","description":"UUID of the tenant","required":true},{"name":"questionnaire_id","in":"path","schemaId":"schema_45","description":"UUID of the questionnaire","required":true}],"pointer":"/paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiKeyCreateRequest","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/participantWriter","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/fullAccess"]}},"schemaId":"components/schemas/ApiKeyCreateRequest","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/participantWriter","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/fullAccess"],"pointer":"/paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tenants/{tenant_id}/questionnaires/{questionnaire_id}/apikeys","servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"parameters":{"path":[{"name":"tenant_id","in":"path","required":true,"schemaId":"schema_45"},{"name":"questionnaire_id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiKeyCreateRequest","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/participantWriter","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/fullAccess"]}},"responseCodes":["201","400","401","403"],"pointer":"/tenants/{tenant_id}/questionnaires/{questionnaire_id}/apikeys","href":"other/createapikey","openApiOperationId":"createApiKey","summary":"API Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"schemaId":"components/schemas/ApiKeyCreateRequest","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/participantWriter","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/fullAccess"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiKeyCreateRequest","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/participantWriter","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/fullAccess"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key created. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is shown only once — save it now."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKey","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/ApiKey","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"Invalid request body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingKeyName","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingScope"]}},"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingKeyName","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingScope"]},{"code":"401","description":"Missing or invalid API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key does not have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apikey:write"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/403/content/application~1json/examples/forbidden"]}],"pointer":"/paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ApiKey","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKey","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingKeyName","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingScope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingKeyName","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingScope"]}}},{"code":"401","schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/403/content/application~1json/examples/forbidden"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/createapikey"}],"panels":[]}]},"httpPath":"/tenants/{tenant_id}/questionnaires/{questionnaire_id}/apikeys"},{"label":"API Key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public/integration-api/other/deleteapikey","routeSlug":"/apis/public/integration-api/other/deleteapikey","metadata":{"seo":{"title":"API Key","description":"Permanently delete an API key. Requires the apikey:delete scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApiKey","name":"API Key","isWebhook":false,"pointer":"/paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permanently delete an API key. Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apikey:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This action cannot be undone. Any integration using the deleted key will immediately"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start receiving "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apikey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter accepts:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The raw "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_key value"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenant_id","in":"path","schemaId":"schema_45","description":"UUID of the tenant","required":true},{"name":"questionnaire_id","in":"path","schemaId":"schema_45","description":"UUID of the questionnaire","required":true},{"name":"apikey","in":"path","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_key value of the key to delete."},"children":[]}]}]}],"required":true,"examples":{"apiKeyValue":{"summary":"Delete by api_key value","value":"3f8a1b2c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a"}}}],"pointer":"/paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tenants/{tenant_id}/questionnaires/{questionnaire_id}/apikeys/{apikey}","servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"parameters":{"path":[{"name":"tenant_id","in":"path","required":true,"schemaId":"schema_45"},{"name":"questionnaire_id","in":"path","required":true,"schemaId":"schema_45"},{"name":"apikey","in":"path","required":true,"example":"3f8a1b2c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a","schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/tenants/{tenant_id}/questionnaires/{questionnaire_id}/apikeys/{apikey}","href":"other/deleteapikey","openApiOperationId":"deleteApiKey","summary":"API Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"API key deleted successfully"},{"code":"400","description":"apikey path parameter is missing or empty","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/400/content/application~1json/examples/missingKeyId"]}},"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/400/content/application~1json/examples/missingKeyId"]},{"code":"401","description":"Missing or invalid API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/missingHeader","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/invalidKey"]}},"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/missingHeader","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/invalidKey"]},{"code":"403","description":"Insufficient scope","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/403/content/application~1json/examples/insufficientScope"]}},"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/403/content/application~1json/examples/insufficientScope"]},{"code":"404","description":"API key not found or does not belong to this questionnaire/tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/404/content/application~1json/examples/notFound"]}],"pointer":"/paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/400/content/application~1json/examples/missingKeyId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/400/content/application~1json/examples/missingKeyId"]}}},{"code":"401","schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/missingHeader","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/invalidKey"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/missingHeader","paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/invalidKey"]}}},{"code":"403","schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/403/content/application~1json/examples/insufficientScope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/403/content/application~1json/examples/insufficientScope"]}}},{"code":"404","schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyErrorResponse","exampleIds":["paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/404/content/application~1json/examples/notFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/deleteapikey"}],"panels":[]}]},"httpPath":"/tenants/{tenant_id}/questionnaires/{questionnaire_id}/apikeys/{apikey}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Result Update Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/public/integration-api/paths/result_update/post","routeSlug":"/apis/public/integration-api/paths/result_update/post","metadata":{"seo":{"title":"Result Update Webhook","description":"Clearspeed sends a POST request to the customer's webhook endpoint when a result is published or updated. Customers must return HTTP 200 to acknowledge receipt."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Result Update Webhook","isWebhook":true,"pointer":"/paths/result_update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Result Update Webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Clearspeed sends a POST request to the customer's webhook endpoint\nwhen a result is published or updated.\nCustomers must return HTTP 200 to acknowledge receipt.\n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResultWebhookRequest","exampleIds":["paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with AR","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Incomplete","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Partial","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with HR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR~1AD","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> R","paths/result_update/post/requestBody/content/application~1json/examples/Under_Review"]}},"schemaId":"components/schemas/ResultWebhookRequest","exampleIds":["paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with AR","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Incomplete","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Partial","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with HR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR~1AD","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> R","paths/result_update/post/requestBody/content/application~1json/examples/Under_Review"],"pointer":"/paths/result_update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"result_update","servers":[{"url":"https://www.customerapi.com/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ResultWebhookRequest","exampleIds":["paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with AR","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Incomplete","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Partial","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with HR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR~1AD","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> R","paths/result_update/post/requestBody/content/application~1json/examples/Under_Review"]}},"responseCodes":["200"],"pointer":"result_update","href":"paths/result_update/post","summary":"Result Update Webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://www.customerapi.com/v1"}],"schemaId":"components/schemas/ResultWebhookRequest","exampleIds":["paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with AR","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Incomplete","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Partial","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with HR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR~1AD","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> R","paths/result_update/post/requestBody/content/application~1json/examples/Under_Review"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResultWebhookRequest","exampleIds":["paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with AR","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Incomplete","paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Partial","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with HR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR~1AD","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> G","paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> R","paths/result_update/post/requestBody/content/application~1json/examples/Under_Review"]}},"examples":[{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Result received"}],"pointer":"/paths/result_update/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paths/result_update/post"}],"panels":[]}]},"httpPath":"result_update"}],"store":{"schemaStore":{"components/schemas/Participant":{"id":"components/schemas/Participant","kind":"json-schema","title":"Participant","data":{"type":"object","properties":{"project_uuid":{"type":"string","description":"UUID of the project/questionnaire","example":"fd9690b0-9050-4acd-ad74-7f906c07fe93"},"phone_number1":{"type":"string","description":"Primary phone number (optional)","example":"+916263877039"},"phone_number2":{"type":"string","description":"Secondary phone number (optional)","example":""},"interview_ref_num":{"type":"string","description":"Interview reference number","example":"7858934895810"},"external_ref_id":{"type":"string","description":"External reference ID (optional)","example":"12345-46b5-464d-a8e4-afecc"},"email":{"type":"string","description":"Email address (optional)","example":"participant@gmail.com"},"language":{"type":"string","description":"Language name (optional)","example":"English"}},"required":["project_uuid","interview_ref_num"]}},"components/schemas/LegacyParticipantResponse":{"id":"components/schemas/LegacyParticipantResponse","kind":"json-schema","title":"LegacyParticipantResponse","data":{"type":"object","description":"Legacy v1 participant response with outcome tracking fields","properties":{"project_uuid":{"type":"string","description":"UUID of the project/questionnaire","example":"fd9690b0-9050-4acd-ad74-7f906c07fe93"},"phone_number1":{"type":"string","description":"Primary phone number","example":"+916263877039"},"phone_number2":{"type":"string","description":"Secondary phone number","example":""},"interview_ref_num":{"type":"string","description":"Interview reference number","example":"7858934895810"},"external_ref_id":{"type":"string","description":"External reference ID","example":"12345-46b5-464d-a8e4-afecc"},"participant_uuid":{"type":"string","description":"UUID of the participant","example":"01977df0-57c1-7dcf-8916-df741aa66691"},"email":{"type":"string","description":"Email address","example":"participant@gmail.com"},"language":{"type":"string","description":"Participant language","example":"English"},"particpant_guide_link":{"type":"string","description":"Link to the participant guide","example":"https://guide.example.com?id=01977df0-57c1-7dcf-8916-df741aa66691"},"is_participant_allowed":{"type":"boolean","description":"Whether participant is allowed after call-blocking checks","example":true},"outcome":{"type":["string","null"]},"outcome_ts":{"type":["string","null"]}}}},"components/schemas/OutcomeTrackingResponse":{"id":"components/schemas/OutcomeTrackingResponse","kind":"json-schema","title":"OutcomeTrackingResponse","data":{"type":"object","description":"Outcome tracking response","properties":{"project_uuid":{"type":"string","description":"UUID of the project/questionnaire","example":"fd9690b0-9050-4acd-ad74-7f906c07fe93"},"phone_number1":{"type":"string","description":"Primary phone number","example":"+916263877039"},"phone_number2":{"type":"string","description":"Secondary phone number","example":""},"interview_ref_num":{"type":"string","description":"Interview reference number","example":"7858934895810"},"external_ref_id":{"type":"string","description":"External reference ID","example":"12345-46b5-464d-a8e4-afecc"},"participant_uuid":{"type":"string","description":"UUID of the participant","example":"01977df0-57c1-7dcf-8916-df741aa66691"},"email":{"type":"string","description":"Email address","example":"participant@gmail.com"},"language":{"type":"string","description":"Participant language","example":"English"},"particpant_guide_link":{"type":"string","description":"Link to the participant guide","example":"https://guide.example.com?id=01977df0-57c1-7dcf-8916-df741aa66691"},"is_participant_allowed":{"type":"boolean","description":"Whether participant is allowed after call-blocking checks","example":true},"outcome":{"type":["string","null"],"description":"Outcome code for the participant","example":"$10,Reviewed and Mitigated"},"outcome_ts":{"type":["string","null"],"format":"date-time","description":"Outcome timestamp in RFC3339 format","example":"2025-12-12T06:06:29Z"}}}},"components/schemas/LegacyErrorResponse":{"id":"components/schemas/LegacyErrorResponse","kind":"json-schema","title":"LegacyErrorResponse","data":{"type":"object","description":"Legacy v1 error response format","properties":{"error":{"type":"string","enum":["UNAUTHORIZED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","INTERNAL_SERVER_ERROR"]},"status":{"type":"integer"},"message":{"type":"string"},"timestamp":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-MM-YYYY HH:MM:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}]}}}},"components/schemas/OutcomeTrackingErrorResponse":{"id":"components/schemas/OutcomeTrackingErrorResponse","kind":"json-schema","title":"OutcomeTrackingErrorResponse","data":{"type":"object","description":"Error response schema for outcome tracking","properties":{"error":{"type":"string","enum":["UNAUTHORIZED","BAD_REQUEST","NOT_FOUND","FORBIDDEN"]},"status":{"type":"integer"},"message":{"type":"string"},"timestamp":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-MM-YYYY HH:MM:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}]}}}},"components/schemas/ResultWebhookRequest":{"id":"components/schemas/ResultWebhookRequest","kind":"json-schema","title":"ResultWebhookRequest","data":{"type":"object","description":"Clearspeed sends this JSON payload to your configured customer webhook URL\nwhen a result is published or updated.\nThis is an incoming callback payload, not a Clearspeed endpoint request.\n","example":{"project_uuid":"XXXXXXXX-ef1f-4d91-a2e2-7b33132b00f1","callback_type":"Result Update","access_code":"7136XXXX59","interview_ref_num":"456XXXX642","status":"Result Published","questions_risk_rating":[{"sequence":"7","risk_level":"LR","text":"Q7 "},{"sequence":"2","risk_level":"HR","text":"Q2 "}],"overall_evaluation":"HR","is_admission":false,"is_counter_measure":false,"is_not_complete":false,"participant_language":"English","summary":"AR","summary_bgcolor":"#dc3545","clear":true},"properties":{"project_uuid":{"type":"string"},"callback_type":{"type":"string"},"access_code":{"type":"string"},"interview_ref_num":{"type":"string"},"status":{"type":"string"},"questions_risk_rating":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"string"},"risk_level":{"type":"string"},"text":{"type":"string"}}}},"overall_evaluation":{"type":"string"},"is_admission":{"type":"boolean"},"is_counter_measure":{"type":"boolean"},"is_not_complete":{"type":"boolean"},"participant_language":{"type":"string"},"summary":{"type":"string","description":"Result summary label (for example, HR/LR/G/AR/NC)"},"summary_bgcolor":{"type":"string","description":"Hex color code associated with the summary label","example":"#28a745"},"clear":{"type":"boolean","description":"Whether result is clear"},"timestamp":{"type":"string","format":"date-time"}}}},"components/schemas/ApiKeyCreateRequest":{"id":"components/schemas/ApiKeyCreateRequest","kind":"json-schema","title":"ApiKeyCreateRequest","data":{"type":"object","description":"Request body for creating a new API key","required":["key_name","scopes"],"properties":{"key_name":{"type":"string","description":"Human-readable name to identify this key","example":"ci-participant-writer"},"scopes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of scopes to grant this key. Valid values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"participant:write"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — create participants"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apikey:write"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — create API keys for the same questionnaire"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apikey:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — delete API keys for the same questionnaire"},"children":[]}]}]}]}],"items":{"type":"string","enum":["participant:write","apikey:write","apikey:delete"]},"example":["participant:write"]}}}},"components/schemas/ApiKey":{"id":"components/schemas/ApiKey","kind":"json-schema","title":"ApiKey","data":{"type":"object","description":"An API key record","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the API key","example":"a1b2c3d4-0000-0000-0000-000000000001"},"api_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API key value. Returned in full only on creation — masked in all subsequent responses."},"children":[]}]}]}],"example":"cs_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"},"key_name":{"type":"string","description":"Human-readable name for the key","example":"ci-participant-writer"},"scopes":{"type":"array","description":"Scopes granted to this key","items":{"type":"string"},"example":["participant:write"]},"questionnaire_id":{"type":"string","format":"uuid","description":"UUID of the questionnaire this key is scoped to","example":"fd9690b0-9050-4acd-ad74-7f906c07fe93"},"create_ts":{"type":"string","format":"date-time","description":"Creation timestamp (UTC)","example":"2026-04-10T10:00:00Z"},"update_ts":{"type":"string","format":"date-time","description":"Last updated timestamp (UTC)","example":"2026-04-10T10:00:00Z"}}}},"components/schemas/ApiKeyErrorResponse":{"id":"components/schemas/ApiKeyErrorResponse","kind":"json-schema","title":"ApiKeyErrorResponse","data":{"type":"object","description":"Error response for API key operations","properties":{"error":{"type":"string","description":"Error message"}}}},"schema_44":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Participant"}]},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","properties":{"outcome":{"type":"string","description":"Outcome code to set for the participant","example":"$10,Reviewed and Mitigated"},"outcome_ts":{"type":"string","format":"date-time","description":"Outcome timestamp in RFC3339 format. If omitted, the current UTC time will be used.\n","example":"2025-12-12T06:06:29Z"}},"required":["outcome"]},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"string"},"id":"schema_47"}},"exampleStore":{"paths/~1v1~1participant/post/requestBody/content/application~1json/examples/create":{"value":{"project_uuid":"fd9690b0-9050-4acd-ad74-7f906c07fe93","phone_number1":"+916263877039","phone_number2":"","interview_ref_num":"7858934895810","external_ref_id":"12345-46b5-464d-a8e4-afecc","email":"participant@gmail.com","language":"English"},"key":"create","summary":"Create new participant","id":"paths/~1v1~1participant/post/requestBody/content/application~1json/examples/create"},"paths/~1v1~1participant/post/responses/200/content/application~1json/examples/participantResponse":{"value":{"project_uuid":"fd9690b0-9050-4acd-ad74-7f906c07fe93","phone_number1":"+916263877039","phone_number2":"","interview_ref_num":"7858934895810","external_ref_id":"12345-46b5-464d-a8e4-afecc","participant_uuid":"01977df0-57c1-7dcf-8916-df741aa66691","email":"participant@gmail.com","language":"English","particpant_guide_link":"https://guide.example.com?id=01977df0-57c1-7dcf-8916-df741aa66691","is_participant_allowed":true,"outcome":null,"outcome_ts":null},"key":"participantResponse","summary":"Create Participant or Retake Questionnaire response","id":"paths/~1v1~1participant/post/responses/200/content/application~1json/examples/participantResponse"},"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/badRequest":{"value":{"error":"BAD_REQUEST","status":400,"message":"Invalid JSON format","timestamp":"27-03-2026 12:34:56"},"key":"badRequest","summary":"Invalid JSON format","id":"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/badRequest"},"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/projectUUIDRequired":{"value":{"error":"BAD_REQUEST","status":400,"message":"project_uuid is required","timestamp":"27-03-2026 12:34:56"},"key":"projectUUIDRequired","summary":"Missing project_uuid","id":"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/projectUUIDRequired"},"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/irnCannotBeEmpty":{"value":{"error":"BAD_REQUEST","status":400,"message":"IRN cannot be empty.","timestamp":"27-03-2026 12:34:56"},"key":"irnCannotBeEmpty","summary":"Missing interview_ref_num / IRN","id":"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/irnCannotBeEmpty"},"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidProjectUUIDFormat":{"value":{"error":"BAD_REQUEST","status":400,"message":"Invalid project_uuid format","timestamp":"27-03-2026 12:34:56"},"key":"invalidProjectUUIDFormat","summary":"Invalid project_uuid format","id":"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidProjectUUIDFormat"},"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidParticipantUUIDFormat":{"value":{"error":"BAD_REQUEST","status":400,"message":"Invalid participant_uuid format","timestamp":"27-03-2026 12:34:56"},"key":"invalidParticipantUUIDFormat","summary":"Invalid participant_uuid format","id":"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidParticipantUUIDFormat"},"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidEmailFormat":{"value":{"error":"BAD_REQUEST","status":400,"message":"Invalid email format","timestamp":"27-03-2026 12:34:56"},"key":"invalidEmailFormat","summary":"Invalid email format","id":"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/invalidEmailFormat"},"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/duplicateIRN":{"value":{"error":"BAD_REQUEST","status":400,"message":"Error: Duplicate IRN. IRN number 7858934895810 has already been assigned to another participant.","timestamp":"27-03-2026 12:34:56"},"key":"duplicateIRN","summary":"Duplicate IRN","id":"paths/~1v1~1participant/post/responses/400/content/application~1json/examples/duplicateIRN"},"paths/~1v1~1participant/post/responses/401/content/application~1json/examples/unauthorized":{"value":{"error":"UNAUTHORIZED","status":401,"message":"API key is required","timestamp":"27-03-2026 12:34:56"},"key":"unauthorized","summary":"API key is required","id":"paths/~1v1~1participant/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1v1~1participant/post/responses/401/content/application~1json/examples/invalidAPIKey":{"value":{"error":"UNAUTHORIZED","status":401,"message":"Invalid API key","timestamp":"27-03-2026 12:34:56"},"key":"invalidAPIKey","summary":"Invalid API key","id":"paths/~1v1~1participant/post/responses/401/content/application~1json/examples/invalidAPIKey"},"paths/~1v1~1participant/post/responses/403/content/application~1json/examples/forbidden":{"value":{"error":"FORBIDDEN","status":403,"message":"API Key not associated with this Questionnaire","timestamp":"27-03-2026 12:34:56"},"key":"forbidden","summary":"Forbidden","id":"paths/~1v1~1participant/post/responses/403/content/application~1json/examples/forbidden"},"paths/~1v1~1participant/post/responses/404/content/application~1json/examples/notFound":{"value":{"error":"NOT_FOUND","status":404,"message":"Participant not found","timestamp":"27-03-2026 12:34:56"},"key":"notFound","summary":"Participant not found","id":"paths/~1v1~1participant/post/responses/404/content/application~1json/examples/notFound"},"paths/~1v1~1participant/post/responses/404/content/application~1json/examples/projectNotFound":{"value":{"error":"NOT_FOUND","status":404,"message":"Project not found","timestamp":"27-03-2026 12:34:56"},"key":"projectNotFound","summary":"Project not found","id":"paths/~1v1~1participant/post/responses/404/content/application~1json/examples/projectNotFound"},"paths/~1v1~1participant~1{participant_id}/put/requestBody/content/application~1json/examples/updateOutcome":{"value":{"outcome":"$10,Reviewed and Mitigated","outcome_ts":"2025-12-12T06:06:29Z"},"key":"updateOutcome","summary":"Update participant outcome","id":"paths/~1v1~1participant~1{participant_id}/put/requestBody/content/application~1json/examples/updateOutcome"},"paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/badRequest":{"value":{"error":"BAD_REQUEST","status":400,"message":"Invalid JSON format","timestamp":"27-03-2026 12:34:56"},"key":"badRequest","summary":"Invalid JSON format","id":"paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/badRequest"},"paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidParticipantIdFormat":{"value":{"error":"BAD_REQUEST","status":400,"message":"Invalid participant_id format","timestamp":"27-03-2026 12:34:56"},"key":"invalidParticipantIdFormat","summary":"Invalid participant_id format","id":"paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidParticipantIdFormat"},"paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidOutcomeTsFormat":{"value":{"error":"BAD_REQUEST","status":400,"message":"Invalid outcome_ts format. Use RFC3339 format (e.g., 2025-12-12T06:06:29Z)","timestamp":"27-03-2026 12:34:56"},"key":"invalidOutcomeTsFormat","summary":"Invalid outcome_ts format","id":"paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/invalidOutcomeTsFormat"},"paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/failedToUpdateOutcomeTracking":{"value":{"error":"BAD_REQUEST","status":400,"message":"Failed to update outcome tracking","timestamp":"27-03-2026 12:34:56"},"key":"failedToUpdateOutcomeTracking","summary":"Failed to update outcome tracking","id":"paths/~1v1~1participant~1{participant_id}/put/responses/400/content/application~1json/examples/failedToUpdateOutcomeTracking"},"paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/unauthorized":{"value":{"error":"UNAUTHORIZED","status":401,"message":"API key is required","timestamp":"27-03-2026 12:34:56"},"key":"unauthorized","summary":"API key is required","id":"paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/unauthorized"},"paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/invalidAPIKey":{"value":{"error":"UNAUTHORIZED","status":401,"message":"Invalid API key","timestamp":"27-03-2026 12:34:56"},"key":"invalidAPIKey","summary":"Invalid API key","id":"paths/~1v1~1participant~1{participant_id}/put/responses/401/content/application~1json/examples/invalidAPIKey"},"paths/~1v1~1participant~1{participant_id}/put/responses/403/content/application~1json/examples/forbidden":{"value":{"error":"FORBIDDEN","status":403,"message":"API Key not associated with this Questionnaire","timestamp":"27-03-2026 12:34:56"},"key":"forbidden","summary":"Forbidden","id":"paths/~1v1~1participant~1{participant_id}/put/responses/403/content/application~1json/examples/forbidden"},"paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/notFound":{"value":{"error":"NOT_FOUND","status":404,"message":"Participant not found","timestamp":"27-03-2026 12:34:56"},"key":"notFound","summary":"Participant not found","id":"paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/notFound"},"paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/questionnaireNotFound":{"value":{"error":"NOT_FOUND","status":404,"message":"Questionnaire not found","timestamp":"27-03-2026 12:34:56"},"key":"questionnaireNotFound","summary":"Questionnaire not found","id":"paths/~1v1~1participant~1{participant_id}/put/responses/404/content/application~1json/examples/questionnaireNotFound"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/participantWriter":{"value":{"key_name":"ci-participant-writer","scopes":["participant:write"]},"key":"participantWriter","summary":"Key for creating participants","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/participantWriter"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/fullAccess":{"value":{"key_name":"admin-key","scopes":["participant:write","apikey:write","apikey:delete"]},"key":"fullAccess","summary":"Key with all participant and key management scopes","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/requestBody/content/application~1json/examples/fullAccess"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/201/content/application~1json/examples/created":{"value":{"id":"a1b2c3d4-0000-0000-0000-000000000001","api_key":"cs_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx","key_name":"ci-participant-writer","scopes":["participant:write"],"questionnaire_id":"fd9690b0-9050-4acd-ad74-7f906c07fe93","create_ts":"2026-04-10T10:00:00Z","update_ts":"2026-04-10T10:00:00Z"},"key":"created","summary":"Newly created key (full value visible)","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/201/content/application~1json/examples/created"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingKeyName":{"value":{"error":"key_name is required and cannot be null or empty"},"key":"missingKeyName","summary":"Missing key_name","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingKeyName"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingScope":{"value":{"error":"scope is required and cannot be null or empty"},"key":"missingScope","summary":"Missing scopes","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/400/content/application~1json/examples/missingScope"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/401/content/application~1json/examples/unauthorized":{"value":{"error":"Authorization header is required"},"key":"unauthorized","summary":"No authorization header","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/403/content/application~1json/examples/forbidden":{"value":{"error":"You are not authorized to perform this operation"},"key":"forbidden","summary":"Insufficient scope","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys/post/responses/403/content/application~1json/examples/forbidden"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/400/content/application~1json/examples/missingKeyId":{"value":{"error":"API key value is required"},"key":"missingKeyId","summary":"apikey not provided","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/400/content/application~1json/examples/missingKeyId"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/missingHeader":{"value":{"error":"Authorization header is required"},"key":"missingHeader","summary":"Authorization header not provided","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/missingHeader"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/invalidKey":{"value":{"error":"Invalid API key"},"key":"invalidKey","summary":"API key does not exist or is invalid","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/401/content/application~1json/examples/invalidKey"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/403/content/application~1json/examples/insufficientScope":{"value":{"error":"Invalid API key scope"},"key":"insufficientScope","summary":"API key missing required scope","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/403/content/application~1json/examples/insufficientScope"},"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/404/content/application~1json/examples/notFound":{"value":{"error":"API key not found or Invalid tenant for this questionnaire"},"key":"notFound","summary":"Key not found","id":"paths/~1tenants~1{tenant_id}~1questionnaires~1{questionnaire_id}~1apikeys~1{apikey}/delete/responses/404/content/application~1json/examples/notFound"},"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with AR":{"value":{"project_uuid":"XXXXXXXX-ef1f-4d91-a2e2-7b33132b00f1","callback_type":"Result Update","access_code":"7136XXXX59","interview_ref_num":"456XXXX642","status":"Result Published","questions_risk_rating":[{"sequence":"7","risk_level":"LR","text":"Q7 "},{"sequence":"4","risk_level":"LR","text":"Q4 "},{"sequence":"2","risk_level":"HR","text":"Q2 "},{"sequence":"5","risk_level":"HR","text":"CM Q5 "},{"sequence":"6","risk_level":"HR","text":"Q6 "},{"sequence":"1","risk_level":"HR","text":"CM Q1 "},{"sequence":"3","risk_level":"HR","text":"Q3 "}],"overall_evaluation":"HR","is_admission":false,"is_counter_measure":false,"is_not_complete":false,"participant_language":"English","summary":"AR","summary_bgcolor":"#dc3545","clear":true},"key":"Overall evaluation with AR","summary":"Overall evaluation with AR","id":"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with AR"},"paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Incomplete":{"value":{"project_uuid":"xxxxx-xxxxx-xxxxx-8a5f-xxxx","questions_risk_rating":[{"sequence":"3","risk_level":"DC","text":"Test Question 1","note":"to noisy"}],"callback_type":"Result Update","is_counter_measure":false,"overall_evaluation":"DC","is_not_complete":false,"access_code":"xxxxxx","is_admission":false,"participant_language":"English","interview_ref_num":"xxxxxxxx","status":"Attempted - Incomplete"},"key":"Attempted - Incomplete","summary":"Attempted - Incomplete","id":"paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Incomplete"},"paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Partial":{"value":{"project_uuid":"wwwwwww-wwwwww-1wwwwww","questions_risk_rating":[{"sequence":"1","risk_level":"NC","text":"Q3","note":"to noisy"},{"sequence":"2","risk_level":"NC","text":"Q2","note":"to noisy"},{"sequence":"3","risk_level":"NC","text":"Q1","note":"to noisy"}],"callback_type":"Result Update","is_counter_measure":false,"overall_evaluation":"NC","is_not_complete":true,"access_code":"xxxxxx","is_admission":false,"participant_language":"English","interview_ref_num":"xxxxxxx","status":"Attempted - Partial","summary":"NC","summary_bgcolor":"#6c757d","clear":false},"key":"Attempted - Partial","summary":"Attempted - Partial","id":"paths/result_update/post/requestBody/content/application~1json/examples/Attempted - Partial"},"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with HR":{"value":{"project_uuid":"wwwwwww-wwwwww-1wwwwww","questions_risk_rating":[{"sequence":"6","risk_level":"LR","text":"xxxxxxxxx?","note":"to noisy"},{"sequence":"3","risk_level":"HR","text":"xxxxxx?","note":"to noisy"}],"callback_type":"Result Update","is_counter_measure":false,"overall_evaluation":"HR","is_not_complete":false,"access_code":"xxxxxxx","is_admission":false,"participant_language":"English","interview_ref_num":"xxxxxx","status":"Result Published","summary":"HR","summary_bgcolor":"#dc3545","clear":false},"key":"Overall evaluation with HR","summary":"Overall evaluation with HR","id":"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with HR"},"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR":{"value":{"project_uuid":"wwwwwww-wwwwww-1wwwwww","questions_risk_rating":[{"sequence":"3","risk_level":"LR","text":"xxxxxxxxxx?","note":"to noisy"},{"sequence":"6","risk_level":"LR","text":"xxxxxx?","note":"to noisy"}],"callback_type":"Result Update","is_counter_measure":false,"overall_evaluation":"LR","is_not_complete":false,"access_code":"cxxxxxx","is_admission":false,"participant_language":"English","interview_ref_num":"xxxxxx","status":"Result Published","summary":"AR","summary_bgcolor":"#28a745","clear":true},"key":"Overall evaluation with LR","summary":"Overall evaluation with LR","id":"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR"},"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with G":{"value":{"project_uuid":"xxxxx-xxx-xxx-xxxx-xxxxx","questions_risk_rating":[{"sequence":"1","risk_level":"","text":"xxxxxxx","note":"to noisy"},{"sequence":"2","risk_level":"","text":"xxxxxxx","note":"to noisy"},{"sequence":"3","risk_level":"","text":"xxxxxxx","note":"to noisy"},{"sequence":"4","risk_level":"","text":"xxxxxxx"},{"sequence":"xx","risk_level":"xx","text":"xxxxxxx","note":"to noisy"}],"callback_type":"Result Update","is_counter_measure":false,"overall_evaluation":"G","is_not_complete":false,"access_code":"xxxxxxx","is_admission":false,"participant_language":"English","interview_ref_num":"xxxxxxx","status":"Result Published","timestamp":"xxx-xx-xx:xx:xx","summary":"G","summary_bgcolor":"#28a745","clear":true},"key":"Overall evaluation with G","summary":"Overall evaluation with G","id":"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with G"},"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR~1AD":{"value":{"project_uuid":"wwwwwww-wwwwww-1wwwwww","questions_risk_rating":[{"sequence":"1","risk_level":"AD","text":null,"note":"to noisy"}],"callback_type":"Result Update","is_counter_measure":false,"overall_evaluation":"HR","is_not_complete":false,"access_code":"xxxxxxx","is_admission":true,"participant_language":"English","interview_ref_num":"xxxxxxxx","status":"Result Published","summary":"HR","summary_bgcolor":"#dc3545","clear":false},"key":"Overall evaluation with LR/AD","summary":"Overall evaluation with LR/AD","id":"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with LR~1AD"},"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> G":{"value":{"project_uuid":"xxxxx-xxxx-xxxx-xxxx-xxxxx","questions_risk_rating":[{"sequence":"1","risk_level":"G","text":"xxxxxx","note":"to noisy"},{"sequence":"2","risk_level":"G","text":"xxxxxx","note":"to noisy"},{"sequence":"3","risk_level":"G","text":"xxxxxx","note":"to noisy"},{"sequence":"4","risk_level":"G","text":"xxxxxx","note":"to noisy"}],"callback_type":"Result Update","is_counter_measure":false,"overall_evaluation":"G","is_not_complete":false,"access_code":"xxxxxxxxxx","is_admission":false,"participant_language":"English","interview_ref_num":"xxxxxxxxxxxx","status":"Result Published","timestamp":"xxxx-xxx-xxTxx:xx:xxZ","summary":"G","summary_bgcolor":"#28a745","clear":true},"key":"Overall evaluation with Precision R/G -> G","summary":"Overall evaluation with Precision R/G -> G","id":"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> G"},"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> R":{"value":{"project_uuid":"xxxxx-xxxx-xxxx-xxxx-xxxxx","questions_risk_rating":[{"sequence":"1","risk_level":"G","text":"xxxxxx","note":"to noisy"},{"sequence":"2","risk_level":"G","text":"xxxxxx","note":"to noisy"},{"sequence":"3","risk_level":"G","text":"xxxxxx","note":"to noisy"},{"sequence":"4","risk_level":"R","text":"xxxxxx","note":"to noisy"}],"callback_type":"Result Update","is_counter_measure":false,"overall_evaluation":"R","is_not_complete":false,"access_code":"xxxxxxxxxx","is_admission":false,"participant_language":"English","interview_ref_num":"xxxxxxxxxxxx","status":"Result Published","timestamp":"xxxx-xxx-xxTxx:xx:xxZ","summary":"G","summary_bgcolor":"#28a745","clear":true},"key":"Overall evaluation with Precision R/G -> R","summary":"Overall evaluation with Precision R/G -> R","id":"paths/result_update/post/requestBody/content/application~1json/examples/Overall evaluation with Precision R~1G -> R"},"paths/result_update/post/requestBody/content/application~1json/examples/Under_Review":{"value":{"project_uuid":"wwwwwww-wwwwww-1wwwwww","callback_type":"Result Update","interview_ref_num":"xxxxxxx","access_code":"xxxxxx","status":"under_review"},"key":"Under_Review","summary":"Under_Review","id":"paths/result_update/post/requestBody/content/application~1json/examples/Under_Review"}},"securitySchemeStore":{"authorization":{"id":"authorization","type":"apiKey","in":"header","paramName":"Authorization"}},"servers":[{"url":"https://api.us.clearspeed.com/questionnaire","description":"US Production server"},{"url":"https://api.uk.clearspeed.com/questionnaire","description":"UK Production server"}]},"options":{"hideReplay":true,"hideDownloadButton":true,"feedback":{"type":"sentiment","settings":{"comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"},"label":"Was this section helpful?"}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/public/integration-api.json?download"},{"url":"/_bundle/apis/public/integration-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Clearspeed Integration API","description":"## Overview\nThe Clearspeed Integration API enables you to programmatically manage participants\nwithin your questionnaires — create new participants 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://developer.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` |\n| UK Production | `https://api.uk.clearspeed.com/questionnaire` |\n"}},"baseSlug":"/apis/public/integration-api","routesMapping":{}}