{"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":"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":"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":"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/appointments/list","slug":"/api-reference/appointments/list","pageMetadata":{"title":"List all appointments","openapi":"GET /appointments","description":null,"href":"/api-reference/appointments/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 appointments","openapi":"GET /appointments","description":null,"href":"/api-reference/appointments/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"appointment.index","tags":["Appointment"],"parameters":["963ac7fe-3a8c-4679-863a-00219a736298","24f4ef32-ee4e-4b5c-8fdf-6e362a1d2a6b","7165c4f5-db6f-41cd-871e-da84e3100dbf","a9fa5dc5-8233-4289-90f7-d9bd1e0ef7bc","45b5ff61-6771-46ac-bebc-04193a0bbfee","b8366658-6916-4493-95f1-f0f288ccf35f","d0c024d8-42df-404a-951a-f8e9c096b84c","2c4718ac-bf80-4918-9aa3-f0a18a69399d","a23a1608-322b-4c1f-8508-07ca7a09ef4f"],"responses":{"200":"770818ad-df02-4d36-86de-b2e736604890","401":"e7544312-c2a4-488f-8444-8b0327af7402","422":"ee9ec104-a1ed-49a3-a9b8-3cbabdb8d27f"},"method":"get","type":"path","servers":["b51841f5-4355-48a1-b2f3-7d6dae140360"],"security":[],"path":"/appointments","baseUrlOptions":["https://api.caspen.com/v1"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"963ac7fe-3a8c-4679-863a-00219a736298":{"name":"location_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"24f4ef32-ee4e-4b5c-8fdf-6e362a1d2a6b":{"name":"practitioner_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"7165c4f5-db6f-41cd-871e-da84e3100dbf":{"name":"service_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"a9fa5dc5-8233-4289-90f7-d9bd1e0ef7bc":{"name":"client_id","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"45b5ff61-6771-46ac-bebc-04193a0bbfee":{"name":"status","in":"query","schema":{"type":"string","enum":["pending","arrived","missed","cancelled"],"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"b8366658-6916-4493-95f1-f0f288ccf35f":{"name":"starts_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},"d0c024d8-42df-404a-951a-f8e9c096b84c":{"name":"ends_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},"2c4718ac-bf80-4918-9aa3-f0a18a69399d":{"name":"cursor","in":"query","schema":{"type":"string","uniqueKey":"","typeLabel":"string"}},"a23a1608-322b-4c1f-8508-07ca7a09ef4f":{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"uniqueKey":"","typeLabel":"integer"}}},"responses":{"770818ad-df02-4d36-86de-b2e736604890":{"description":"Paginated set of `AppointmentResource`","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The appointment's unique identifier.","examples":["app_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"location_id":{"type":"string","description":"The location identifier where the appointment takes place.","examples":["loc_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].location_id","typeLabel":"string"},"practitioner_id":{"type":"string","description":"The practitioner identifier who provides the service.","examples":["pra_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].practitioner_id","typeLabel":"string"},"service_id":{"type":"string","description":"The service identifier being provided.","examples":["ser_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].service_id","typeLabel":"string"},"service_price":{"type":"integer","description":"The snapshotted base price from the service at time of booking.","examples":[12000],"uniqueKey":"data.items.[INDEX].service_price","typeLabel":"integer"},"price":{"type":"integer","description":"The calculated total price (service_price × client count if price_per_client).","examples":[24000],"uniqueKey":"data.items.[INDEX].price","typeLabel":"integer"},"price_unit":{"type":"string","enum":["hourly","fixed"],"title":"ServicePriceUnit","description":"The snapshotted price unit from the service at time of booking.","examples":["hourly"],"uniqueKey":"data.items.[INDEX].price_unit","typeLabel":"enum\u003cstring>"},"price_per_client":{"type":"boolean","description":"Whether the price is per client (true) or per appointment (false).","examples":[false],"uniqueKey":"data.items.[INDEX].price_per_client","typeLabel":"boolean"},"travel":{"type":"boolean","description":"Whether billable travel time applies to this appointment.","examples":[true],"uniqueKey":"data.items.[INDEX].travel","typeLabel":"boolean"},"travel_name":{"oneOf":[{"type":"string","description":"The snapshotted travel line item name.","examples":["Travel"],"uniqueKey":"data.items.[INDEX].travel_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The snapshotted travel line item name.","examples":["Travel"],"uniqueKey":"data.items.[INDEX].travel_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_name","typeLabel":"string | null"},"travel_price":{"oneOf":[{"type":"integer","description":"The snapshotted flat travel price in cents.","examples":[5000],"uniqueKey":"data.items.[INDEX].travel_price.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The snapshotted flat travel price in cents.","examples":[5000],"uniqueKey":"data.items.[INDEX].travel_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_price","typeLabel":"integer | null"},"travel_before_duration":{"oneOf":[{"type":"integer","description":"The billable travel time before the appointment in minutes.","examples":[15],"uniqueKey":"data.items.[INDEX].travel_before_duration.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The billable travel time before the appointment in minutes.","examples":[15],"uniqueKey":"data.items.[INDEX].travel_before_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_before_duration","typeLabel":"integer | null"},"travel_after_duration":{"oneOf":[{"type":"integer","description":"The billable travel time after the appointment in minutes.","examples":[15],"uniqueKey":"data.items.[INDEX].travel_after_duration.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The billable travel time after the appointment in minutes.","examples":[15],"uniqueKey":"data.items.[INDEX].travel_after_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_after_duration","typeLabel":"integer | null"},"travel_address":{"oneOf":[{"type":"string","description":"The travel destination address (single-line, free text).","examples":["123 Sample Street, Sydney NSW 2000, Australia"],"uniqueKey":"data.items.[INDEX].travel_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"The travel destination address (single-line, free text).","examples":["123 Sample Street, Sydney NSW 2000, Australia"],"uniqueKey":"data.items.[INDEX].travel_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_address","typeLabel":"string | null"},"travel_expenses":{"type":"array","description":"The travel expense line items (when loaded).","items":{"type":"object","properties":{"id":{"type":"string","description":"The travel expense's unique identifier.","examples":["ate_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"The line item name.","examples":["Mileage"],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The line item name.","examples":["Mileage"],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].name","typeLabel":"string | null"},"price":{"oneOf":[{"type":"integer","description":"The price per unit in cents.","examples":[85],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].price.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The price per unit in cents.","examples":[85],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].price","typeLabel":"integer | null"},"price_unit":{"oneOf":[{"type":"string","title":"ServiceExpensePriceUnit","description":"The unit the price is charged per.","enum":["km","mile","each"],"example":"km","uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].price_unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].price_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].price_unit","typeLabel":"enum\u003cstring> | null"},"quantity":{"oneOf":[{"type":"string","description":"The quantity of units.","examples":["42.50"],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].quantity.oneOf.0","typeLabel":"string"},{"type":"null","description":"The quantity of units.","examples":["42.50"],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX].quantity","typeLabel":"string | null"}},"title":"AppointmentTravelExpenseResource","uniqueKey":"data.items.[INDEX].travel_expenses.items.[INDEX]","typeLabel":"AppointmentTravelExpenseResource · object"},"uniqueKey":"data.items.[INDEX].travel_expenses","typeLabel":"AppointmentTravelExpenseResource · object[]"},"transports":{"type":"array","description":"The transport line items (when loaded).","items":{"type":"object","properties":{"id":{"type":"string","description":"The transport's unique identifier.","examples":["atr_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"The line item name.","examples":["Client transport"],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The line item name.","examples":["Client transport"],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].name","typeLabel":"string | null"},"price":{"oneOf":[{"type":"integer","description":"The price per unit in cents.","examples":[85],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].price.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The price per unit in cents.","examples":[85],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].price","typeLabel":"integer | null"},"price_unit":{"oneOf":[{"type":"string","title":"ServiceExpensePriceUnit","description":"The unit the price is charged per.","enum":["km","mile","each"],"example":"km","uniqueKey":"data.items.[INDEX].transports.items.[INDEX].price_unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"data.items.[INDEX].transports.items.[INDEX].price_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].price_unit","typeLabel":"enum\u003cstring> | null"},"quantity":{"oneOf":[{"type":"string","description":"The quantity of units.","examples":["12.00"],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].quantity.oneOf.0","typeLabel":"string"},{"type":"null","description":"The quantity of units.","examples":["12.00"],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transports.items.[INDEX].quantity","typeLabel":"string | null"}},"title":"AppointmentTransportResource","uniqueKey":"data.items.[INDEX].transports.items.[INDEX]","typeLabel":"AppointmentTransportResource · object"},"uniqueKey":"data.items.[INDEX].transports","typeLabel":"AppointmentTransportResource · object[]"},"appointment_clients":{"type":"array","description":"The appointment clients (when loaded).","items":{"type":"object","properties":{"id":{"type":"string","description":"The appointment client's unique identifier.","examples":["apc_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].id","typeLabel":"string"},"appointment_id":{"type":"string","description":"The appointment identifier.","examples":["apt_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].appointment_id","typeLabel":"string"},"client_id":{"type":"string","description":"The client identifier.","examples":["cli_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].client_id","typeLabel":"string"},"case_id":{"oneOf":[{"type":"string","description":"The case identifier for this client's booking.","examples":["cas_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].case_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The case identifier for this client's booking.","examples":["cas_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].case_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].case_id","typeLabel":"string | null"},"client_package_id":{"oneOf":[{"type":"string","description":"The client package identifier if this booking uses a package.","examples":["cpk_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].client_package_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The client package identifier if this booking uses a package.","examples":["cpk_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].client_package_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].client_package_id","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","title":"AppointmentClientStatus","description":"The attendance status of the client.","enum":["pending","arrived","missed","cancelled"],"example":"arrived","uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].status","typeLabel":"enum\u003cstring> | null"},"do_not_invoice":{"type":"boolean","description":"Whether this client should not be invoiced for this appointment.","examples":[false],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].do_not_invoice","typeLabel":"boolean"},"note":{"oneOf":[{"type":"string","description":"Notes specific to this client's appointment.","examples":["Client requested extra time"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].note.oneOf.0","typeLabel":"string"},{"type":"null","description":"Notes specific to this client's appointment.","examples":["Client requested extra time"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].note.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].note","typeLabel":"string | null"},"confirmed":{"type":"boolean","description":"Whether the client has confirmed their attendance.","examples":[true],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].confirmed","typeLabel":"boolean"},"confirmed_at":{"oneOf":[{"type":"string","description":"When the client confirmed their attendance (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].confirmed_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the client confirmed their attendance (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].confirmed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].confirmed_at","typeLabel":"string | null"},"cancellation_reason_id":{"oneOf":[{"type":"string","description":"The cancellation reason identifier if cancelled.","examples":["cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancellation_reason_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The cancellation reason identifier if cancelled.","examples":["cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancellation_reason_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancellation_reason_id","typeLabel":"string | null"},"cancellation_note":{"oneOf":[{"type":"string","description":"Additional notes about the cancellation.","examples":["Client called to cancel"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancellation_note.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional notes about the cancellation.","examples":["Client called to cancel"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancellation_note.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancellation_note","typeLabel":"string | null"},"cancelled_at":{"oneOf":[{"type":"string","description":"When this client's appointment was cancelled (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancelled_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When this client's appointment was cancelled (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancelled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].cancelled_at","typeLabel":"string | null"},"starts_at":{"type":"string","description":"The appointment start time (ISO 8601).","examples":["2024-01-01T09:00:00Z"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].starts_at","typeLabel":"string"},"ends_at":{"type":"string","description":"The appointment end time (ISO 8601).","examples":["2024-01-01T10:00:00Z"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].ends_at","typeLabel":"string"},"created_at":{"type":"string","description":"The timestamp when this record was created (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"The timestamp when this record was last updated (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX].updated_at","typeLabel":"string"}},"title":"AppointmentClientResource","uniqueKey":"data.items.[INDEX].appointment_clients.items.[INDEX]","typeLabel":"AppointmentClientResource · object"},"uniqueKey":"data.items.[INDEX].appointment_clients","typeLabel":"AppointmentClientResource · object[]"},"starts_at":{"type":"string","description":"The appointment start time (ISO 8601).","examples":["2024-01-01T10:00:00Z"],"uniqueKey":"data.items.[INDEX].starts_at","typeLabel":"string"},"ends_at":{"type":"string","description":"The appointment end time (ISO 8601).","examples":["2024-01-01T11:00:00Z"],"uniqueKey":"data.items.[INDEX].ends_at","typeLabel":"string"},"duration":{"type":"integer","description":"The appointment duration in minutes.","examples":[60],"uniqueKey":"data.items.[INDEX].duration","typeLabel":"integer"},"status":{"type":"string","enum":["pending","arrived","missed","cancelled"],"title":"AppointmentStatus","description":"The appointment status.","examples":["pending"],"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"room_id":{"oneOf":[{"type":"string","description":"The room identifier where the appointment takes place.","examples":["rom_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].room_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The room identifier where the appointment takes place.","examples":["rom_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].room_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].room_id","typeLabel":"string | null"},"vehicle_id":{"oneOf":[{"type":"string","description":"The vehicle identifier if transportation is involved.","examples":["veh_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].vehicle_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The vehicle identifier if transportation is involved.","examples":["veh_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].vehicle_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].vehicle_id","typeLabel":"string | null"},"resource_ids":{"type":"array","description":"The IDs of resources required for this appointment.","examples":[["res_01HYHYQHA682J0K1RW7B2HVA9F","res_01HYHYW37MTYJPMT5JV4RN99GK"]],"items":{"type":"string","uniqueKey":"data.items.[INDEX].resource_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].resource_ids","typeLabel":"string[]"},"note":{"oneOf":[{"type":"string","description":"The appointment note.","examples":["Client requested morning appointment."],"uniqueKey":"data.items.[INDEX].note.oneOf.0","typeLabel":"string"},{"type":"null","description":"The appointment note.","examples":["Client requested morning appointment."],"uniqueKey":"data.items.[INDEX].note.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].note","typeLabel":"string | null"},"cancellation_reason_id":{"oneOf":[{"type":"string","description":"The cancellation reason identifier if cancelled.","examples":["cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].cancellation_reason_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The cancellation reason identifier if cancelled.","examples":["cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK"],"uniqueKey":"data.items.[INDEX].cancellation_reason_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].cancellation_reason_id","typeLabel":"string | null"},"cancellation_note":{"oneOf":[{"type":"string","description":"The cancellation note if cancelled.","examples":["Client had to travel unexpectedly."],"uniqueKey":"data.items.[INDEX].cancellation_note.oneOf.0","typeLabel":"string"},{"type":"null","description":"The cancellation note if cancelled.","examples":["Client had to travel unexpectedly."],"uniqueKey":"data.items.[INDEX].cancellation_note.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].cancellation_note","typeLabel":"string | null"},"cancelled_at":{"oneOf":[{"type":"string","description":"When the appointment was cancelled (ISO 8601).","examples":["2024-01-01T08:00:00Z"],"uniqueKey":"data.items.[INDEX].cancelled_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the appointment was cancelled (ISO 8601).","examples":["2024-01-01T08:00:00Z"],"uniqueKey":"data.items.[INDEX].cancelled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].cancelled_at","typeLabel":"string | null"},"archived_at":{"oneOf":[{"type":"string","description":"When the appointment was archived (ISO 8601).","examples":["2024-01-01T08:00:00Z"],"uniqueKey":"data.items.[INDEX].archived_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the appointment was archived (ISO 8601).","examples":["2024-01-01T08: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 appointment was created (ISO 8601).","examples":["2024-01-01T12:00:00Z"],"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string"}},"title":"AppointmentResource","uniqueKey":"data.items.[INDEX]","typeLabel":"AppointmentResource · object"},"title":"AppointmentCollection","isRequired":true,"uniqueKey":"data","typeLabel":"AppointmentResource · 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":"app_01HQFQ9QWTNNPY58FZ8CB3FWWK","location_id":"loc_01HQFQ9QWTNNPY58FZ8CB3FWWK","practitioner_id":"pra_01HQFQ9QWTNNPY58FZ8CB3FWWK","service_id":"ser_01HQFQ9QWTNNPY58FZ8CB3FWWK","service_price":12000,"price":24000,"price_unit":"hourly","price_per_client":false,"travel":true,"travel_name":"Travel","travel_price":5000,"travel_before_duration":15,"travel_after_duration":15,"travel_address":"123 Sample Street, Sydney NSW 2000, Australia","travel_expenses":[{"id":"ate_01HQFQ9QWTNNPY58FZ8CB3FWWK","name":"Mileage","price":85,"price_unit":"km","quantity":"42.50"}],"transports":[{"id":"atr_01HQFQ9QWTNNPY58FZ8CB3FWWK","name":"Client transport","price":85,"price_unit":"km","quantity":"12.00"}],"appointment_clients":[{"id":"apc_01HQFQ9QWTNNPY58FZ8CB3FWWK","appointment_id":"apt_01HQFQ9QWTNNPY58FZ8CB3FWWK","client_id":"cli_01HQFQ9QWTNNPY58FZ8CB3FWWK","case_id":"cas_01HQFQ9QWTNNPY58FZ8CB3FWWK","client_package_id":"cpk_01HQFQ9QWTNNPY58FZ8CB3FWWK","status":"arrived","do_not_invoice":false,"note":"Client requested extra time","confirmed":true,"confirmed_at":"2024-01-01T12:00:00Z","cancellation_reason_id":"cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK","cancellation_note":"Client called to cancel","cancelled_at":"2024-01-01T12:00:00Z","starts_at":"2024-01-01T09:00:00Z","ends_at":"2024-01-01T10:00:00Z","created_at":"2024-01-01T12:00:00Z","updated_at":"2024-01-01T12:00:00Z"}],"starts_at":"2024-01-01T10:00:00Z","ends_at":"2024-01-01T11:00:00Z","duration":60,"status":"pending","room_id":"rom_01HQFQ9QWTNNPY58FZ8CB3FWWK","vehicle_id":"veh_01HQFQ9QWTNNPY58FZ8CB3FWWK","resource_ids":["res_01HYHYQHA682J0K1RW7B2HVA9F","res_01HYHYW37MTYJPMT5JV4RN99GK"],"note":"Client requested morning appointment.","cancellation_reason_id":"cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK","cancellation_note":"Client had to travel unexpectedly.","cancelled_at":"2024-01-01T08:00:00Z","archived_at":"2024-01-01T08:00:00Z","created_at":"2024-01-01T12:00:00Z"}],"links":{"prev":"\u003cstring>","next":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e7544312-c2a4-488f-8444-8b0327af7402":{"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"},"ee9ec104-a1ed-49a3-a9b8-3cbabdb8d27f":{"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 appointments - Caspen API docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-07T07:49:11.288Z","originalFileLocation":"api-reference/appointments/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 appointments - 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/appointments/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=Appointments\u0026amp;title=List+all+appointments\u0026amp;theme=739fe7760d31eea66a59954e\u0026amp;signature=b06364e23d5184b89deb6f3da7a33a847d016f2f42905b44b8d657db9dfabd3c\">\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 appointments - Caspen API docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://caspen.mintlify.app/_mintlify/api/og/v2?division=Appointments\u0026amp;title=List+all+appointments\u0026amp;theme=739fe7760d31eea66a59954e\u0026amp;signature=b06364e23d5184b89deb6f3da7a33a847d016f2f42905b44b8d657db9dfabd3c\">\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/appointments/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/appointments/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/appointments/list#webpage\",\"url\":\"https://docs.caspen.com/api-reference/appointments/list\",\"name\":\"List all appointments\",\"dateModified\":\"2026-08-07T07:49:11.288Z\",\"isPartOf\":{\"@id\":\"https://docs.caspen.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.caspen.com/api-reference/appointments/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.caspen.com/api-reference/appointments/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Appointments\",\"item\":\"https://docs.caspen.com/api-reference/appointments/object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List all appointments\",\"item\":\"https://docs.caspen.com/api-reference/appointments/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.caspen.com/api-reference/appointments/list#apireference\",\"headline\":\"List all appointments\",\"name\":\"List all appointments\",\"url\":\"https://docs.caspen.com/api-reference/appointments/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.caspen.com/api-reference/appointments/list#webpage\"},\"dateModified\":\"2026-08-07T07:49:11.288Z\",\"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","description":null,"href":"/api-reference/appointments/object"},{"title":"List all appointments","openapi":"GET /appointments","href":"/api-reference/appointments/list"},{"title":"Create an appointment","openapi":"POST /appointments","description":null,"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","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}","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 appointments - Caspen API docs","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","b0f84f53ff","2b790eda92","a9bb46feb3"],"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"]}