{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Penciled API Docs","colors":{"primary":"#5E78EE","light":"#5E78EE","dark":"#4B66D1"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/penciled/SUZjkOdGFTAyHS6e/logo/light.svg?fit=max\u0026auto=format\u0026n=SUZjkOdGFTAyHS6e\u0026q=85\u0026s=d6135a08d2ca38cd59dfbb136b4a67f1","dark":"https://mintcdn.com/penciled/SUZjkOdGFTAyHS6e/logo/dark.svg?fit=max\u0026auto=format\u0026n=SUZjkOdGFTAyHS6e\u0026q=85\u0026s=183edd142115ec9a3dcbaae2d30e1962"},"background":{"decoration":null,"color":{"light":"#FDFDFF","dark":"#0F1327"}},"navbar":{"links":[{"label":"Support","href":"mailto:support@penciled.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.penciled.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/penciled"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"penciled","hasAudioNarration":false,"actualSubdomain":"penciled","customDomains":["docs.penciled.com"],"gitSource":{"type":"github","owner":"somnapp","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c54d0e965794a0a764cd","collectionId":"c19aeca5-52e6-406c-82ff-4bdeb3e276da","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae92118a7789b0d4de95dd2:success","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Documentation","count":11},{"language":"default","tag":"API Reference","count":11},{"language":"default","tag":"Webhooks","count":7},{"language":"default","tag":"Calls","count":4},{"language":"default","tag":"Types","count":2},{"language":"default","tag":"Get Started","count":2},{"language":"default","tag":"Agents","count":1},{"language":"default","tag":"API Documentation","count":1},{"language":"default","tag":"Outcomes","count":1},{"language":"default","tag":"Patients","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/call/list","slug":"/api-reference/call/list","pageMetadata":{"title":"List Calls","openapi":"GET /v1/call/list","description":"Gets a list of calls","href":"/api-reference/call/list"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Gets a list of calls\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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 Calls","openapi":"GET /v1/call/list","description":"Gets a list of calls","href":"/api-reference/call/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Gets a list of calls","parameters":["9277c189-1432-4de2-b394-3114237c5b65","1a20efd9-5adf-47d9-8e91-8b3958bcd59f","1f4b24ed-8f37-4ffe-8acd-8af774b611b2"],"responses":{"200":"2c5fe75c-07c0-4190-b8e9-55f28d9cb595","400":"6534405d-3170-4a85-a1e9-27c6f63b24cb"},"method":"get","type":"path","servers":["e69f3397-8462-4ccf-9dfd-4979e268f411"],"security":["97c8111c-1e99-45d2-8ab3-e55028d2ced1"],"path":"/v1/call/list","baseUrlOptions":["https://api.penciled.com"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9277c189-1432-4de2-b394-3114237c5b65":{"name":"agent_ids","in":"query","description":"The ID of the agent that made the call","required":false,"schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"example":["991b6987-297d-4c94-b700-ab6e51eef955","0a831269-388d-477b-a8df-a8e69eb613c0","0a831269-388d-477b-a8df-a8e69eb613c0"],"isRequired":false,"description":"The ID of the agent that made the call","uniqueKey":"","typeLabel":"string[]"}},"1a20efd9-5adf-47d9-8e91-8b3958bcd59f":{"name":"last_evaluated_key","in":"query","description":"The last evaluated key for pagination","required":false,"schema":{"type":"object","properties":{"started_at":{"type":"string","format":"date-time","example":"2024-07-15T18:46:15.932Z","uniqueKey":"started_at","typeLabel":"string\u003cdate-time>"},"call_id":{"type":"string","example":"082a358a-c5dc-4b33-8253-45c3f169d2e5","uniqueKey":"call_id","typeLabel":"string"},"organization_id":{"type":"string","example":"913585df-56a2-449a-b150-e0e3dfe80ed0","uniqueKey":"organization_id","typeLabel":"string"}},"isRequired":false,"description":"The last evaluated key for pagination","uniqueKey":"","typeLabel":"object"}},"1f4b24ed-8f37-4ffe-8acd-8af774b611b2":{"name":"page_size","in":"query","description":"The number of calls per page (optional, default is 20, max is 50)","required":false,"schema":{"type":"integer","default":20,"maximum":50,"isRequired":false,"description":"The number of calls per page (optional, default is 20, max is 50)","uniqueKey":"","typeLabel":"integer"}}},"responses":{"2c5fe75c-07c0-4190-b8e9-55f28d9cb595":{"description":"Call response","content":{"application/json":{"schema":{"type":"object","properties":{"calls":{"type":"array","items":{"type":"object","properties":{"call_id":{"type":"string","isRequired":true,"uniqueKey":"calls.items.[INDEX].call_id","typeLabel":"string"},"agent_id":{"type":"string","isRequired":true,"uniqueKey":"calls.items.[INDEX].agent_id","typeLabel":"string"},"outcome":{"type":"string","enum":["confirmed","unconfirmed","unknown","requested_callback"],"uniqueKey":"calls.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["calling","completed","error","voicemail"],"uniqueKey":"calls.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"outcome_justification":{"type":"string","uniqueKey":"calls.items.[INDEX].outcome_justification","typeLabel":"string"},"appointment_date":{"type":"string","format":"date-time","uniqueKey":"calls.items.[INDEX].appointment_date","typeLabel":"string\u003cdate-time>"},"summary":{"type":"string","uniqueKey":"calls.items.[INDEX].summary","typeLabel":"string"},"started_at":{"type":"string","format":"date-time","uniqueKey":"calls.items.[INDEX].started_at","typeLabel":"string\u003cdate-time>"},"ended_at":{"type":"string","format":"date-time","uniqueKey":"calls.items.[INDEX].ended_at","typeLabel":"string\u003cdate-time>"},"call_length":{"type":"string","uniqueKey":"calls.items.[INDEX].call_length","typeLabel":"string"},"recordingWav":{"type":"string","uniqueKey":"calls.items.[INDEX].recordingWav","typeLabel":"string"},"transcript":{"type":"string","uniqueKey":"calls.items.[INDEX].transcript","typeLabel":"string"}},"required":["call_id","agent_id"],"uniqueKey":"calls.items.[INDEX]","typeLabel":"object"},"uniqueKey":"calls","typeLabel":"object[]"},"lastEvaluatedKey":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"lastEvaluatedKey.additionalProperties","typeLabel":"string"},"uniqueKey":"lastEvaluatedKey","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"calls":[{"call_id":"\u003cstring>","agent_id":"\u003cstring>","outcome":"confirmed","status":"calling","outcome_justification":"\u003cstring>","appointment_date":"2023-11-07T05:31:56Z","summary":"\u003cstring>","started_at":"2023-11-07T05:31:56Z","ended_at":"2023-11-07T05:31:56Z","call_length":"\u003cstring>","recordingWav":"\u003cstring>","transcript":"\u003cstring>"}],"lastEvaluatedKey":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"6534405d-3170-4a85-a1e9-27c6f63b24cb":{"description":"Unexpected error","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"97c8111c-1e99-45d2-8ab3-e55028d2ced1":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"e69f3397-8462-4ccf-9dfd-4979e268f411":{"url":"https://api.penciled.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"penciled","siteName":"Penciled API Docs","title":"List Calls - Penciled API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T02:47:02.758Z","originalFileLocation":"api-reference/call/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=\"description\" content=\"Gets a list of calls\">\u003cmeta data-mint-head name=\"application-name\" content=\"Penciled 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/penciled/nDNkatlJ2gFZ3Wsp/_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/penciled/nDNkatlJ2gFZ3Wsp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/penciled/nDNkatlJ2gFZ3Wsp/_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/penciled/nDNkatlJ2gFZ3Wsp/_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/penciled/nDNkatlJ2gFZ3Wsp/_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/penciled/nDNkatlJ2gFZ3Wsp/_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/penciled/nDNkatlJ2gFZ3Wsp/_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/penciled/nDNkatlJ2gFZ3Wsp/_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/penciled/nDNkatlJ2gFZ3Wsp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Calls - Penciled API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gets a list of calls\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Penciled API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.penciled.com/api-reference/call/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://penciled.mintlify.site/_mintlify/api/og/v2?division=Calls\u0026amp;title=List+Calls\u0026amp;description=Gets+a+list+of+calls\u0026amp;theme=077bf91c2bb0d3c2bd8a387a\u0026amp;signature=2422cc7194d12ea13bdc22c562e83a16ffabfd3a6d3a9b99637f11a720536bfa\">\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 Calls - Penciled API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gets a list of calls\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://penciled.mintlify.site/_mintlify/api/og/v2?division=Calls\u0026amp;title=List+Calls\u0026amp;description=Gets+a+list+of+calls\u0026amp;theme=077bf91c2bb0d3c2bd8a387a\u0026amp;signature=2422cc7194d12ea13bdc22c562e83a16ffabfd3a6d3a9b99637f11a720536bfa\">\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/penciled/nDNkatlJ2gFZ3Wsp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Penciled API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5E78EE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.penciled.com/api-reference/call/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/call/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.penciled.com/#organization\",\"name\":\"Penciled API Docs\",\"url\":\"https://docs.penciled.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/penciled/SUZjkOdGFTAyHS6e/logo/light.svg?fit=max\u0026auto=format\u0026n=SUZjkOdGFTAyHS6e\u0026q=85\u0026s=d6135a08d2ca38cd59dfbb136b4a67f1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.penciled.com#website\",\"name\":\"Penciled API Docs\",\"url\":\"https://docs.penciled.com\",\"publisher\":{\"@id\":\"https://docs.penciled.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.penciled.com/api-reference/call/list#webpage\",\"url\":\"https://docs.penciled.com/api-reference/call/list\",\"name\":\"List Calls\",\"description\":\"Gets a list of calls\",\"dateModified\":\"2026-01-07T02:47:02.758Z\",\"isPartOf\":{\"@id\":\"https://docs.penciled.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.penciled.com/api-reference/call/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.penciled.com/api-reference/call/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Calls\",\"item\":\"https://docs.penciled.com/api-reference/call/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Calls\",\"item\":\"https://docs.penciled.com/api-reference/call/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.penciled.com/api-reference/call/list#apireference\",\"headline\":\"List Calls\",\"name\":\"List Calls\",\"description\":\"Gets a list of calls\",\"url\":\"https://docs.penciled.com/api-reference/call/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.penciled.com/api-reference/call/list#webpage\"},\"dateModified\":\"2026-01-07T02:47:02.758Z\",\"publisher\":{\"@id\":\"https://docs.penciled.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.penciled.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Penciled API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Penciled API Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Penciled API","href":"/api-reference/introduction"}]},{"group":"Calls","pages":[{"title":"Get Call","openapi":"GET /v1/call","href":"/api-reference/call/get"},{"title":"Make call","openapi":"POST /v1/call","href":"/api-reference/call/create"},{"title":"Delete Call","openapi":"DELETE /v1/call","description":"Deletes a single call based on the ID supplied","href":"/api-reference/call/delete"},{"title":"List Calls","openapi":"GET /v1/call/list","href":"/api-reference/call/list"}]},{"group":"Variables","pages":[{"title":"Get Variables","openapi":"GET /v1/variables","description":"Gets the variables for a specific agent","href":"/api-reference/variables/get"}]},{"group":"Outcomes","pages":[{"title":"Get Outcomes","openapi":"GET /v1/outcomes","href":"/api-reference/outcomes/get"}]},{"group":"Agents","pages":[{"title":"Get Agents","openapi":"GET /v1/agents","href":"/api-reference/agents/get"}]},{"group":"Patients","pages":[{"title":"Get Patients","openapi":"GET /v1/patients","href":"/api-reference/patients/get"}]},{"group":"Waitlist","pages":[{"title":"Get Waitlist","openapi":"GET /v1/waitlist","href":"/api-reference/waitlist/get"}]},{"group":"Waitlist Runs","pages":[{"title":"Get Waitlist Runs","openapi":"GET /v1/waitlistruns","href":"/api-reference/waitlistruns/get"}]}]}]},"basePath":"","title":"List Calls - Penciled API Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}