{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Caspen API docs","colors":{"primary":"#4338CA","light":"#818cf8","dark":"#3730A3"},"logo":{"light":"https://mintcdn.com/caspen/2PtU9GIHCCfy-5mN/logo/light.svg?fit=max\u0026auto=format\u0026n=2PtU9GIHCCfy-5mN\u0026q=85\u0026s=b33435b7faec2ca4f87a2d40469e9f02","dark":"https://mintcdn.com/caspen/2PtU9GIHCCfy-5mN/logo/dark.svg?fit=max\u0026auto=format\u0026n=2PtU9GIHCCfy-5mN\u0026q=85\u0026s=9d16bfa8d30942a01b1b5a4f939a29e4"},"favicon":"https://mintcdn.com/caspen/4DnkxWE_0tvELwnO/favicon.svg?fit=max\u0026auto=format\u0026n=4DnkxWE_0tvELwnO\u0026q=85\u0026s=bb2d9311f870794e725f9d36eadeac52","api":{"playground":{"display":"simple"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.caspen.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://support.caspen.com"},{"anchor":"Website","icon":"browser","href":"https://caspen.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"caspen","hasAudioNarration":false,"actualSubdomain":"caspen","customDomains":["docs.caspen.com"],"gitSource":{"type":"github","owner":"robertmylne","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a758de405a7ef6c5688f013","collectionId":"2cd82b6d-6d63-4e74-98aa-0db4ca2ca3c4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a758de405a7ef6c5688f013"},"entitlements":{},"buildId":"6a758de405a7ef6c5688f013:success","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API documentation","count":7},{"language":"default","tag":"Busy Times","count":6},{"language":"default","tag":"Appointments","count":5},{"language":"default","tag":"Clients","count":5},{"language":"default","tag":"Appointment Clients","count":3},{"language":"default","tag":"Contacts","count":3},{"language":"default","tag":"Form Templates","count":3},{"language":"default","tag":"Forms","count":3},{"language":"default","tag":"Locations","count":3},{"language":"default","tag":"Practitioners","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#content .api-section:last-child{display:none}"}],"page":{"pagePath":"api-reference/forms/list","slug":"/api-reference/forms/list","pageMetadata":{"title":"List all forms","openapi":"GET /forms","description":null,"href":"/api-reference/forms/list"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List all forms","openapi":"GET /forms","description":null,"href":"/api-reference/forms/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"form.index","tags":["Form"],"parameters":["2de0f029-e1f3-4c6f-916c-964ce4274af5","d85713bc-b15c-4764-b58b-dc44119e9bf2","871d3a89-7717-4fc4-a9f7-8868d86fcfdf","0654f26e-5b04-4c18-8add-4b5313d8b849","3bebec20-ea38-476e-8c2c-e1a5b1942a21","6366be06-7bdd-49df-89ed-93f4049ab0f1","881037ed-7ad4-4dc0-ae3c-4e867fe3f932","ce697659-ca80-4466-8126-18bd8abb36be","b1ffeb03-f0c8-41ea-9534-d5c6a5b41046"],"responses":{"200":"55c9203b-cda0-40c7-8fdd-938555df273d","401":"3092a1bc-64f2-46d6-8b76-c5ae34eaa0e5","422":"5c063ddf-a0a7-4f89-a598-c5216258ddc9"},"method":"get","type":"path","servers":["b51841f5-4355-48a1-b2f3-7d6dae140360"],"security":[],"path":"/forms","baseUrlOptions":["https://api.caspen.com/v1"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2de0f029-e1f3-4c6f-916c-964ce4274af5":{"name":"form_template_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"d85713bc-b15c-4764-b58b-dc44119e9bf2":{"name":"location_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"871d3a89-7717-4fc4-a9f7-8868d86fcfdf":{"name":"client_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"0654f26e-5b04-4c18-8add-4b5313d8b849":{"name":"appointment_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"3bebec20-ea38-476e-8c2c-e1a5b1942a21":{"name":"appointment_client_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"6366be06-7bdd-49df-89ed-93f4049ab0f1":{"name":"status","in":"query","schema":{"type":"string","enum":["not_started","in_progress","completed"],"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"881037ed-7ad4-4dc0-ae3c-4e867fe3f932":{"name":"completed_at","in":"query","style":"deepObject","schema":{"type":"object","properties":{"gt":{"type":"string","format":"date-time","uniqueKey":"gt","typeLabel":"string\u003cdate-time>"},"gte":{"type":"string","format":"date-time","uniqueKey":"gte","typeLabel":"string\u003cdate-time>"},"lt":{"type":"string","format":"date-time","uniqueKey":"lt","typeLabel":"string\u003cdate-time>"},"lte":{"type":"string","format":"date-time","uniqueKey":"lte","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"explode":true},"ce697659-ca80-4466-8126-18bd8abb36be":{"name":"cursor","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"b1ffeb03-f0c8-41ea-9534-d5c6a5b41046":{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":10,"uniqueKey":"","typeLabel":"integer"}}},"responses":{"55c9203b-cda0-40c7-8fdd-938555df273d":{"description":"Paginated set of `FormResource`","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The form's unique identifier.","examples":["for_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"client_id":{"type":"string","description":"The identifier of the client the form belongs to.","examples":["cli_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].client_id","typeLabel":"string"},"location_id":{"oneOf":[{"type":"string","description":"The identifier of the location the form is associated with.","examples":["loc_01HZR88VXZ3G2NTVPEB2PCCKDY"],"uniqueKey":"data.items.[INDEX].location_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier of the location the form is associated with.","examples":["loc_01HZR88VXZ3G2NTVPEB2PCCKDY"],"uniqueKey":"data.items.[INDEX].location_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].location_id","typeLabel":"string | null"},"form_template_id":{"type":"string","description":"The identifier of the form template the form was created from.","examples":["fte_01HYHYQHA682J0K1RW7B2HVA9F"],"uniqueKey":"data.items.[INDEX].form_template_id","typeLabel":"string"},"appointment_client_id":{"oneOf":[{"type":"string","description":"The identifier of the appointment client the form was created for.","examples":["apc_01HYHYW37MTYJPMT5JV4RN99GK"],"uniqueKey":"data.items.[INDEX].appointment_client_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier of the appointment client the form was created for.","examples":["apc_01HYHYW37MTYJPMT5JV4RN99GK"],"uniqueKey":"data.items.[INDEX].appointment_client_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_client_id","typeLabel":"string | null"},"name":{"type":"string","description":"The form's name.","examples":["Intake questionnaire"],"uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"color":{"type":"string","description":"The form's display colour.","examples":["blue"],"uniqueKey":"data.items.[INDEX].color","typeLabel":"string"},"completion_message":{"type":"string","description":"The message shown to the client once the form is submitted.","examples":["Thanks for completing your form."],"uniqueKey":"data.items.[INDEX].completion_message","typeLabel":"string"},"prefill_client_fields":{"type":"boolean","description":"Whether the client's existing details are prefilled into the form.","examples":[true],"uniqueKey":"data.items.[INDEX].prefill_client_fields","typeLabel":"boolean"},"override_client_fields":{"type":"boolean","description":"Whether submitting the form overwrites the client's existing details.","examples":[false],"uniqueKey":"data.items.[INDEX].override_client_fields","typeLabel":"boolean"},"status":{"type":"string","enum":["not_started","in_progress","completed"],"title":"FormStatus","description":"The form's completion status.","examples":["completed"],"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"sent_status":{"oneOf":[{"type":"string","description":"The form's delivery status, or null if it has not been sent.","examples":["viewed"],"uniqueKey":"data.items.[INDEX].sent_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The form's delivery status, or null if it has not been sent.","examples":["viewed"],"uniqueKey":"data.items.[INDEX].sent_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].sent_status","typeLabel":"string | null"},"content":{"type":"array","description":"The form's pages, sections, questions and answers.","items":{"type":"object","properties":{"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections.items.[INDEX].title","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections.items.[INDEX].description","typeLabel":"string | null"},"questions":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections.items.[INDEX].questions.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections.items.[INDEX].questions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections.items.[INDEX].questions","typeLabel":"object[]"}},"required":["title","description","questions"],"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].content.items.[INDEX].sections","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].content.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].content","typeLabel":"object[]"},"hosted_form_url":{"type":"string","description":"The URL the client uses to complete the form.","examples":["https://example.caspen.com/form/for_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].hosted_form_url","typeLabel":"string"},"sent_at":{"oneOf":[{"type":"string","description":"The timestamp when the form was sent to the client (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].sent_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The timestamp when the form was sent to the client (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].sent_at","typeLabel":"string | null"},"viewed_at":{"oneOf":[{"type":"string","description":"The timestamp when the client first viewed the form (ISO 8601).","examples":["2024-01-01T13:00:00Z"],"uniqueKey":"data.items.[INDEX].viewed_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The timestamp when the client first viewed the form (ISO 8601).","examples":["2024-01-01T13:00:00Z"],"uniqueKey":"data.items.[INDEX].viewed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].viewed_at","typeLabel":"string | null"},"completed_at":{"oneOf":[{"type":"string","description":"The timestamp when the client completed the form (ISO 8601).","examples":["2024-01-01T14:00:00Z"],"uniqueKey":"data.items.[INDEX].completed_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The timestamp when the client completed the form (ISO 8601).","examples":["2024-01-01T14:00:00Z"],"uniqueKey":"data.items.[INDEX].completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].completed_at","typeLabel":"string | null"},"archived_at":{"oneOf":[{"type":"string","description":"The timestamp when the form was archived (ISO 8601), or null if it is active.","examples":["2024-02-01T09:00:00Z"],"uniqueKey":"data.items.[INDEX].archived_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The timestamp when the form was archived (ISO 8601), or null if it is active.","examples":["2024-02-01T09:00:00Z"],"uniqueKey":"data.items.[INDEX].archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].archived_at","typeLabel":"string | null"},"created_at":{"type":"string","description":"The timestamp when the form was created (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string"}},"title":"FormResource","uniqueKey":"data.items.[INDEX]","typeLabel":"FormResource · object"},"title":"FormCollection","isRequired":true,"uniqueKey":"data","typeLabel":"FormResource · object[]"},"links":{"type":"object","properties":{"prev":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"links.prev.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"links.prev.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"links.prev","typeLabel":"string | null"},"next":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"links.next.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"links.next.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"links.next","typeLabel":"string | null"}},"required":["prev","next"],"isRequired":true,"uniqueKey":"links","typeLabel":"object"}},"required":["data","links"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"for_01HQFQ9QWTNNPY58FZ8CB3FWWK","client_id":"cli_01HQFQ9QWTNNPY58FZ8CB3FWWK","location_id":"loc_01HZR88VXZ3G2NTVPEB2PCCKDY","form_template_id":"fte_01HYHYQHA682J0K1RW7B2HVA9F","appointment_client_id":"apc_01HYHYW37MTYJPMT5JV4RN99GK","name":"Intake questionnaire","color":"blue","completion_message":"Thanks for completing your form.","prefill_client_fields":true,"override_client_fields":false,"status":"completed","sent_status":"viewed","content":[{"sections":[{"title":"\u003cstring>","description":"\u003cstring>","questions":[{}]}]}],"hosted_form_url":"https://example.caspen.com/form/for_01HQFQ9QWTNNPY58FZ8CB3FWWK","sent_at":"2024-01-01T12:00:00Z","viewed_at":"2024-01-01T13:00:00Z","completed_at":"2024-01-01T14:00:00Z","archived_at":"2024-02-01T09:00:00Z","created_at":"2024-01-01T12:00:00Z"}],"links":{"prev":"\u003cstring>","next":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3092a1bc-64f2-46d6-8b76-c5ae34eaa0e5":{"description":"Unauthenticated","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5c063ddf-a0a7-4f89-a598-c5216258ddc9":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Errors overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"A detailed description of each field that failed validation.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"required":["message","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"b51841f5-4355-48a1-b2f3-7d6dae140360":{"url":"https://api.caspen.com/v1","description":"Production"}}},"originalFileLocation":"api-reference/api.json"},"subdomain":"caspen","siteName":"Caspen API docs","title":"List all forms - Caspen API docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-07T07:49:11.236Z","originalFileLocation":"api-reference/forms/list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Caspen API docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List all forms - Caspen API docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Caspen API docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.caspen.com/api-reference/forms/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://caspen.mintlify.app/_mintlify/api/og/v2?division=Forms\u0026amp;title=List+all+forms\u0026amp;theme=739fe7760d31eea66a59954e\u0026amp;signature=08c38fc78237a9c5ce6a75b08ba5d2bf7844712bce3f7de7f846fc6eef4b653b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List all forms - Caspen API docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://caspen.mintlify.app/_mintlify/api/og/v2?division=Forms\u0026amp;title=List+all+forms\u0026amp;theme=739fe7760d31eea66a59954e\u0026amp;signature=08c38fc78237a9c5ce6a75b08ba5d2bf7844712bce3f7de7f846fc6eef4b653b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/caspen/1ZqdzwBYl3J-WO2Q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Caspen API docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4338CA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.caspen.com/api-reference/forms/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/forms/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.caspen.com/#organization\",\"name\":\"Caspen API docs\",\"url\":\"https://docs.caspen.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/caspen/2PtU9GIHCCfy-5mN/logo/light.svg?fit=max\u0026auto=format\u0026n=2PtU9GIHCCfy-5mN\u0026q=85\u0026s=b33435b7faec2ca4f87a2d40469e9f02\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.caspen.com#website\",\"name\":\"Caspen API docs\",\"url\":\"https://docs.caspen.com\",\"publisher\":{\"@id\":\"https://docs.caspen.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.caspen.com/api-reference/forms/list#webpage\",\"url\":\"https://docs.caspen.com/api-reference/forms/list\",\"name\":\"List all forms\",\"dateModified\":\"2026-08-07T07:49:11.236Z\",\"isPartOf\":{\"@id\":\"https://docs.caspen.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.caspen.com/api-reference/forms/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.caspen.com/api-reference/forms/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Forms\",\"item\":\"https://docs.caspen.com/api-reference/forms/object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List all forms\",\"item\":\"https://docs.caspen.com/api-reference/forms/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.caspen.com/api-reference/forms/list#apireference\",\"headline\":\"List all forms\",\"name\":\"List all forms\",\"url\":\"https://docs.caspen.com/api-reference/forms/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.caspen.com/api-reference/forms/list#webpage\"},\"dateModified\":\"2026-08-07T07:49:11.236Z\",\"publisher\":{\"@id\":\"https://docs.caspen.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.caspen.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Caspen API docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Caspen API docs","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://support.caspen.com"},{"anchor":"Website","icon":"browser","href":"https://caspen.com"}]},"groups":[{"group":"API documentation","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Authentication","href":"/authentication"},{"title":"Errors","href":"/errors"},{"title":"Pagination","href":"/pagination"},{"title":"Security","href":"/security"},{"title":"Rate Limits","href":"/rate-limits"},{"title":"Dates and Times","href":"/dates-times"}]},{"group":"Appointment Clients","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The appointment client object","href":"/api-reference/appointment-clients/object"},{"title":"List all appointment clients","openapi":"GET /appointment_clients","href":"/api-reference/appointment-clients/list"},{"title":"Retrieve an appointment client","openapi":"GET /appointment_clients/{appointmentClient}","href":"/api-reference/appointment-clients/retrieve"}]},{"group":"Appointments","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The appointment object","href":"/api-reference/appointments/object"},{"title":"List all appointments","openapi":"GET /appointments","href":"/api-reference/appointments/list"},{"title":"Create an appointment","openapi":"POST /appointments","href":"/api-reference/appointments/create"},{"title":"Retrieve an appointment","openapi":"GET /appointments/{appointment}","href":"/api-reference/appointments/retrieve"},{"title":"Update an appointment","openapi":"POST /appointments/{appointment}","href":"/api-reference/appointments/update"}]},{"group":"Availabilities","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The availability object","href":"/api-reference/availabilities/object"},{"title":"List all availabilities","openapi":"GET /availabilities","href":"/api-reference/availabilities/list"}]},{"group":"Availability Slots","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The availability slot object","href":"/api-reference/availability-slots/object"},{"title":"List all availability slots","openapi":"GET /availability_slots","href":"/api-reference/availability-slots/list"}]},{"group":"Busy Times","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The busy time object","href":"/api-reference/busy-times/object"},{"title":"List all busy times","openapi":"GET /busy_times","href":"/api-reference/busy-times/list"},{"title":"Create a busy time","openapi":"POST /busy_times","href":"/api-reference/busy-times/create"},{"title":"Retrieve a busy time","openapi":"GET /busy_times/{busyTime}","href":"/api-reference/busy-times/retrieve"},{"title":"Update a busy time","openapi":"POST /busy_times/{busyTime}","href":"/api-reference/busy-times/update"},{"title":"Archive a busy time","openapi":"POST /busy_times/{busyTime}/archive","href":"/api-reference/busy-times/archive"}]},{"group":"Clients","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The client object","href":"/api-reference/clients/object"},{"title":"List all clients","openapi":"GET /clients","href":"/api-reference/clients/list"},{"title":"Create a client","openapi":"POST /clients","href":"/api-reference/clients/create"},{"title":"Retrieve a client","openapi":"GET /clients/{client}","href":"/api-reference/clients/retrieve"},{"title":"Update a client","openapi":"POST /clients/{client}","href":"/api-reference/clients/update"}]},{"group":"Contacts","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The contact object","href":"/api-reference/contacts/object"},{"title":"List all contacts","openapi":"GET /contacts","href":"/api-reference/contacts/list"},{"title":"Retrieve a contact","openapi":"GET /contacts/{contact}","href":"/api-reference/contacts/retrieve"}]},{"group":"Form Templates","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The form template object","href":"/api-reference/form-templates/object"},{"title":"List all form templates","openapi":"GET /form_templates","href":"/api-reference/form-templates/list"},{"title":"Retrieve a form template","openapi":"GET /form_templates/{formTemplate}","href":"/api-reference/form-templates/retrieve"}]},{"group":"Forms","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The form object","description":null,"href":"/api-reference/forms/object"},{"title":"List all forms","openapi":"GET /forms","href":"/api-reference/forms/list"},{"title":"Retrieve a form","openapi":"GET /forms/{form}","description":null,"href":"/api-reference/forms/retrieve"}]},{"group":"Locations","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The location object","href":"/api-reference/locations/object"},{"title":"List all locations","openapi":"GET /locations","href":"/api-reference/locations/list"},{"title":"Retrieve a location","openapi":"GET /locations/{location}","href":"/api-reference/locations/retrieve"}]},{"group":"Practitioners","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The practitioner object","href":"/api-reference/practitioners/object"},{"title":"List all practitioners","openapi":"GET /practitioners","href":"/api-reference/practitioners/list"},{"title":"Retrieve a practitioner","openapi":"GET /practitioners/{practitioner}","href":"/api-reference/practitioners/retrieve"}]},{"group":"Services","pages":[{"icon":"brackets-curly","iconType":"duotone","title":"The service object","href":"/api-reference/services/object"},{"title":"List all services","openapi":"GET /services","href":"/api-reference/services/list"},{"title":"Retrieve a service","openapi":"GET /services/{service}","href":"/api-reference/services/retrieve"}]}]},"title":"List all forms - Caspen API docs","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-D5fEM6aW.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}