{
"error": {
"code": "INVALID_REQUEST",
"message": "The request was invalid.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#bad-request",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "No valid API key provided.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unauthorized",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "FORBIDDEN",
"message": "The API key doesn’t have permissions to perform the request.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#forbidden",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#not-found",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Invalid query parameters",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unprocessable-entity",
"details": {
"issues": [
{
"code": "too_small",
"minimum": 1,
"type": "number",
"inclusive": true,
"exact": false,
"message": "Number must be greater than or equal to 1",
"path": [
"limit"
]
}
]
},
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is currently unavailable.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#service-unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
Interactions
(Beta) List upcoming interactions
deprecated
Retrieves paginated upcoming interactions linked to a person, company, or object.
This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.
This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.
{
"error": {
"code": "INVALID_REQUEST",
"message": "The request was invalid.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#bad-request",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "No valid API key provided.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unauthorized",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "FORBIDDEN",
"message": "The API key doesn’t have permissions to perform the request.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#forbidden",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#not-found",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Invalid query parameters",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unprocessable-entity",
"details": {
"issues": [
{
"code": "too_small",
"minimum": 1,
"type": "number",
"inclusive": true,
"exact": false,
"message": "Number must be greater than or equal to 1",
"path": [
"limit"
]
}
]
},
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is currently unavailable.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#service-unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Folk Developer Portal","description":"Developer portal and API reference of folk","colors":{"primary":"#000000","light":"#ffffff","dark":"#222222"},"logo":{"light":"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=08eda1dcbb1eefceac8ca5fea9c103d8","dark":"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=f7a85c0692d36cf4ae95ba0cb3a13827"},"favicon":{"light":"https://mintcdn.com/folk-cf968f5e/HcSGFJR-HRVkFe3E/assets/favicon-light.svg?fit=max\u0026auto=format\u0026n=HcSGFJR-HRVkFe3E\u0026q=85\u0026s=f507f5945e391292cf6679ecee54f2a0","dark":"https://mintcdn.com/folk-cf968f5e/HcSGFJR-HRVkFe3E/assets/favicon-dark.svg?fit=max\u0026auto=format\u0026n=HcSGFJR-HRVkFe3E\u0026q=85\u0026s=26f07b15afad6f7a4467054d25a0f955"},"api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","python","ruby","go","php"]}},"navbar":{"links":[{"href":"intercom://show","label":"Chat with support"},{"href":"https://www.folk.app/contact-sales","label":"Get a demo"}],"primary":{"type":"button","label":"Open app","href":"https://app.folk.app"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/folkhq","x":"https://twitter.com/folkhq","youtube":"https://www.youtube.com/channel/UCs3bswOUZvkouum7Rdx4i5w"}},"integrations":{"intercom":{"appId":"rn8e78eq"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"folk-cf968f5e","hasAudioNarration":false,"actualSubdomain":"folk-cf968f5e","customDomains":["developer.folk.app"],"gitSource":{"type":"github","owner":"folkapp-mintlify-prod","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae8ad32e4f1cb0cd68b0027","collectionId":"e408cff9-b342-4ba5-9ea1-88ffd3ebbf08","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae8ad32e4f1cb0cd68b0027"},"entitlements":{},"buildId":"6aea0a52e52981415f8d1a37","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":97},{"language":"default","tag":"Available endpoints","count":86},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Campaigns","count":15},{"language":"default","tag":"Introduction","count":11},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Core concepts","count":9},{"language":"default","tag":"Companies","count":8},{"language":"default","tag":"Custom objects","count":8},{"language":"default","tag":"People","count":8}]},"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":"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":"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":"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":"full-page-search","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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* vietnamese */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGHInHEVA.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGGInHEVA.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGIInE.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--font-family-headings-custom:'Bricolage Grotesque', sans-serif}h1,h2,h3,h4,h5,h6{font-optical-sizing:auto;font-weight:600;font-style:normal;font-variation-settings:'wdth' 100}.dark{--background-dark:25 25 25}#home-cta-button,.dark #topbar-cta-button>a>span{border:1px solid rgb(var(--gray-800))}.prose :where(a):not(:where([class~='not-prose'], [class~='not-prose'] *)){border-color:rgb(var(--primary-dark))}.dark .prose :where(a):not(:where([class~='not-prose'], [class~='not-prose'] *)){border-color:rgb(var(--primary-light))}.nav-tag-pill-text{font-weight:500!important;text-shadow:none;color:#fff!important;background-color:#2563eb!important}.dark .nav-tag-pill-text{background-color:#3b82f6!important}"}],"page":{"pagePath":"api-reference/interactions/list-upcoming-interactions","slug":"/api-reference/interactions/list-upcoming-interactions","pageMetadata":{"title":"(Beta) List upcoming interactions","description":"Retrieves paginated upcoming interactions linked to a person, company, or object.\u003cbr/>\u003cWarning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.\u003c/Warning>\u003cbr/>\u003cWarning>This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\u003c/Warning>","deprecated":true,"version":null,"tag":"Beta","sidebarTitle":"List upcoming interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions/upcoming","href":"/api-reference/interactions/list-upcoming-interactions","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n }, {Warning} = _components;\n if (!Warning) _missingMdxReference(\"Warning\", true);\n return _jsxs(_components.p, {\n children: [\"Retrieves paginated upcoming interactions linked to a person, company, or object.\", _jsx(\"br\", {}), _jsx(Warning, {\n children: \"This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.\"\n }), _jsx(\"br\", {}), _jsx(Warning, {\n children: \"This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\"\n })]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\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":"(Beta) List upcoming interactions","description":"Retrieves paginated upcoming interactions linked to a person, company, or object.\u003cbr/>\u003cWarning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.\u003c/Warning>\u003cbr/>\u003cWarning>This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\u003c/Warning>","deprecated":true,"version":null,"tag":"Beta","sidebarTitle":"List upcoming interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions/upcoming","href":"/api-reference/interactions/list-upcoming-interactions","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/folk-cf968f5e/c239747596c4df94/intercom.js"],"openApiReferenceData":{"operation":{"security":["94681b7a-14ac-4f35-b567-788b1f8bc348"],"deprecated":true,"x-mint":{"metadata":{"tag":"Beta","title":"(Beta) List upcoming interactions","sidebarTitle":"List upcoming interactions"}},"operationId":"listUpcomingInteractions","summary":"List upcoming interactions","description":"Retrieves paginated upcoming interactions linked to a person, company, or object.\u003cbr/>\u003cWarning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.\u003c/Warning>\u003cbr/>\u003cWarning>This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\u003c/Warning>","tags":["Interactions"],"parameters":["f88ce1a9-cd7f-45d0-8f1a-9965503d7890","8220d3a8-29fa-47ae-a759-39047fffad38"],"responses":{"200":"6baba0b6-f479-42a5-bad0-37aecfa1c773","400":"5d6f5d3d-2ba2-4459-940c-5304d497f659","401":"52ef525d-84d4-44e8-9ffb-6a7191a2a594","403":"0c88c6f6-c775-4ee5-b24f-f3c7d773d270","404":"72c23c1b-c1ef-4b1e-8667-28d4faef8aa5","422":"54b9dfac-50ed-471b-a9e4-6b3f1f05de82","429":"139bb0ca-118a-46d1-8ec5-98ae6b4f9c54","500":"d0060b01-0177-4659-8fc5-3370bb8f40bf","503":"e085b8b0-33c3-45ae-b2c5-3fe683fcf147"},"method":"get","type":"path","servers":["4a52fd1c-f45c-4b69-88e2-0ac14d254310"],"path":"/v1/interactions/upcoming","baseUrlOptions":["https://api.folk.app"],"title":"List upcoming interactions","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","ruby","go","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f88ce1a9-cd7f-45d0-8f1a-9965503d7890":{"schema":{"type":"string","maxLength":512,"isRequired":false,"description":"A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the `pagination.nextLink` value returned in a previous response to request subsequent results.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the `pagination.nextLink` value returned in a previous response to request subsequent results.","example":"eyJvZmZzZXQiOjN9","name":"cursor","in":"query"},"8220d3a8-29fa-47ae-a759-39047fffad38":{"schema":{"type":"string","minLength":40,"maxLength":40,"isRequired":true,"description":"The person, company, or object linked to interactions.","uniqueKey":"","typeLabel":"string"},"required":true,"description":"The person, company, or object linked to interactions.","example":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"entity.id","in":"query"}},"responses":{"6baba0b6-f479-42a5-bad0-37aecfa1c773":{"description":"A paginated list of upcoming interactions with optional pagination link.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"items":{"type":"array","items":{"oneOf":[{"type":"object","description":"An interaction linked to an entity. Can be imported (email, calendar, WhatsApp, call) or manually logged.","required":["id","entity","dateTime","url","privacyLevel","interactionType","from","to","content"],"example":{"id":"lit_b049db09-c03d-4f32-96d6-d314760add5d","interactionType":"logged","entity":{"id":"per_55175e81-9a52-4ac3-930e-82792c23499b","entityType":"person","fullName":"John Doe"},"dateTime":"2025-07-17T09:00:00.000Z","url":"https://mail.google.com/mail/u/0/#inbox/abc123","privacyLevel":"sharedFull","from":{"type":"user","value":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","name":"John Doe"},"to":{"type":"person","value":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"John Doe"},"content":"Had a coffee with John Doe\nDiscussed the new project."},"properties":{"id":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.id","typeLabel":"string"},"entity":{"type":"object","properties":{"entityType":{"type":"string","enum":["person","company"],"description":"The type of the entity connected to the interaction. Can be `person` or `company`.","example":"person","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.entity.entityType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","minLength":40,"maxLength":40,"description":"The ID of the entity connected to the interaction.","example":"per_55175e81-9a52-4ac3-930e-82792c23499b","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.entity.id","typeLabel":"string"},"fullName":{"type":"string","description":"The full name of the entity connected to the interaction.","example":"John Doe","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.entity.fullName","typeLabel":"string"}},"required":["entityType","id","fullName"],"description":"The entity connected to the interaction.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.entity","typeLabel":"object"},"dateTime":{"type":"string","format":"date-time","description":"The date and time of the interaction.","example":"2025-07-17T09:00:00.000Z","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.dateTime","typeLabel":"string\u003cdate-time>"},"url":{"oneOf":[{"type":"string","format":"uri","description":"A link to open the interaction in the original source, when available.","example":"https://mail.google.com/mail/u/0/#inbox/abc123","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"A link to open the interaction in the original source, when available.","example":"https://mail.google.com/mail/u/0/#inbox/abc123","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.url","typeLabel":"string\u003curi> | null"},"privacyLevel":{"type":"string","enum":["sharedFull","subjectOnly","sensitive","internal"],"description":"Interaction privacy level:\n- `**sharedFull` means the interaction content is fully visible to every workspace member.\n- `**subjectOnly` means the interacton content is hidden for other workspace members.\n- `**sensitve`/`internal` means the interaction is visible only to the workspace members involved in the conversation.\nFor more information about interaction privacy, see our [help center article](https://help.folk.app/en/articles/13056598-security-internal-and-sensitive-interactions)\n","example":"sharedFull","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.privacyLevel","typeLabel":"enum\u003cstring>"},"interactionType":{"type":"string","enum":["email"],"description":"The interaction is an imported email message.","example":"email","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.interactionType","typeLabel":"enum\u003cstring>"},"from":{"type":"object","properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.from.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The email address of the participant.","example":"jane@example.com","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.from.value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.from.name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.from.picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.from.userId","typeLabel":"string"}},"required":["type","value"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.from","typeLabel":"object"},"to":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.to.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The email address of the participant.","example":"jane@example.com","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.to.items.[INDEX].value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.to.items.[INDEX].name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.to.items.[INDEX].picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.to.items.[INDEX].userId","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.to.items.[INDEX]","typeLabel":"object"},"description":"The recipients of the email.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.to","typeLabel":"object[]"},"content":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email or calendar event.","example":"Project kickoff","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.content.subject","typeLabel":"string"},"snippet":{"type":"string","description":"A short preview of the interaction content. Omitted when privacy rules restrict content.","example":"Looking forward to discussing the roadmap.","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.content.snippet","typeLabel":"string"},"location":{"type":"string","description":"The location of the calendar event, when available.","example":"Conference room A","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.content.location","typeLabel":"string"},"body":{"type":"string","description":"The full body of the email or calendar event. Only returned by the get interaction endpoint.","example":"Hi team,\n\nLooking forward to our kickoff meeting.","uniqueKey":"data.\\items.items.[INDEX].oneOf.0.content.body","typeLabel":"string"}},"required":["subject"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.0.content","typeLabel":"object"}},"uniqueKey":"data.\\items.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"An interaction linked to an entity. Can be imported (email, calendar, WhatsApp, call) or manually logged.","required":["id","entity","dateTime","url","privacyLevel","interactionType","from","to","content"],"example":{"id":"lit_b049db09-c03d-4f32-96d6-d314760add5d","interactionType":"logged","entity":{"id":"per_55175e81-9a52-4ac3-930e-82792c23499b","entityType":"person","fullName":"John Doe"},"dateTime":"2025-07-17T09:00:00.000Z","url":"https://calendar.google.com/event?eid=abc123","privacyLevel":"sharedFull","from":{"type":"user","value":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","name":"John Doe"},"to":{"type":"person","value":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"John Doe"},"content":"Had a coffee with John Doe\nDiscussed the new project."},"properties":{"id":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.id","typeLabel":"string"},"entity":{"type":"object","properties":{"entityType":{"type":"string","enum":["person","company"],"description":"The type of the entity connected to the interaction. Can be `person` or `company`.","example":"person","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.entity.entityType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","minLength":40,"maxLength":40,"description":"The ID of the entity connected to the interaction.","example":"per_55175e81-9a52-4ac3-930e-82792c23499b","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.entity.id","typeLabel":"string"},"fullName":{"type":"string","description":"The full name of the entity connected to the interaction.","example":"John Doe","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.entity.fullName","typeLabel":"string"}},"required":["entityType","id","fullName"],"description":"The entity connected to the interaction.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.entity","typeLabel":"object"},"dateTime":{"type":"string","format":"date-time","description":"The date and time of the interaction.","example":"2025-07-17T09:00:00.000Z","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.dateTime","typeLabel":"string\u003cdate-time>"},"url":{"oneOf":[{"type":"string","format":"uri","description":"A link to open the interaction in the original source, when available.","example":"https://mail.google.com/mail/u/0/#inbox/abc123","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"A link to open the interaction in the original source, when available.","example":"https://mail.google.com/mail/u/0/#inbox/abc123","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.url","typeLabel":"string\u003curi> | null"},"privacyLevel":{"type":"string","enum":["sharedFull","subjectOnly","sensitive","internal"],"description":"Interaction privacy level:\n- `**sharedFull` means the interaction content is fully visible to every workspace member.\n- `**subjectOnly` means the interacton content is hidden for other workspace members.\n- `**sensitve`/`internal` means the interaction is visible only to the workspace members involved in the conversation.\nFor more information about interaction privacy, see our [help center article](https://help.folk.app/en/articles/13056598-security-internal-and-sensitive-interactions)\n","example":"sharedFull","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.privacyLevel","typeLabel":"enum\u003cstring>"},"interactionType":{"type":"string","enum":["calendar"],"description":"The interaction is an imported calendar event.","example":"calendar","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.interactionType","typeLabel":"enum\u003cstring>"},"from":{"type":"object","properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.from.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The email address of the participant.","example":"jane@example.com","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.from.value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.from.name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.from.picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.from.userId","typeLabel":"string"}},"required":["type","value"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.from","typeLabel":"object"},"to":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.to.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The email address of the participant.","example":"jane@example.com","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.to.items.[INDEX].value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.to.items.[INDEX].name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.to.items.[INDEX].picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.to.items.[INDEX].userId","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.to.items.[INDEX]","typeLabel":"object"},"description":"The attendees of the calendar event.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.to","typeLabel":"object[]"},"content":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email or calendar event.","example":"Project kickoff","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.content.subject","typeLabel":"string"},"snippet":{"type":"string","description":"A short preview of the interaction content. Omitted when privacy rules restrict content.","example":"Looking forward to discussing the roadmap.","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.content.snippet","typeLabel":"string"},"location":{"type":"string","description":"The location of the calendar event, when available.","example":"Conference room A","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.content.location","typeLabel":"string"},"body":{"type":"string","description":"The full body of the email or calendar event. Only returned by the get interaction endpoint.","example":"Hi team,\n\nLooking forward to our kickoff meeting.","uniqueKey":"data.\\items.items.[INDEX].oneOf.1.content.body","typeLabel":"string"}},"required":["subject"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.1.content","typeLabel":"object"}},"uniqueKey":"data.\\items.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"An interaction linked to an entity. Can be imported (email, calendar, WhatsApp, call) or manually logged.","required":["id","entity","dateTime","url","privacyLevel","interactionType","from","to","content"],"example":{"id":"lit_b049db09-c03d-4f32-96d6-d314760add5d","interactionType":"logged","entity":{"id":"per_55175e81-9a52-4ac3-930e-82792c23499b","entityType":"person","fullName":"John Doe"},"dateTime":"2025-07-17T09:00:00.000Z","url":null,"privacyLevel":"sharedFull","from":{"type":"user","value":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","name":"John Doe"},"to":{"type":"person","value":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"John Doe"},"content":"Had a coffee with John Doe\nDiscussed the new project."},"properties":{"id":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.id","typeLabel":"string"},"entity":{"type":"object","properties":{"entityType":{"type":"string","enum":["person","company"],"description":"The type of the entity connected to the interaction. Can be `person` or `company`.","example":"person","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.entity.entityType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","minLength":40,"maxLength":40,"description":"The ID of the entity connected to the interaction.","example":"per_55175e81-9a52-4ac3-930e-82792c23499b","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.entity.id","typeLabel":"string"},"fullName":{"type":"string","description":"The full name of the entity connected to the interaction.","example":"John Doe","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.entity.fullName","typeLabel":"string"}},"required":["entityType","id","fullName"],"description":"The entity connected to the interaction.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.entity","typeLabel":"object"},"dateTime":{"type":"string","format":"date-time","description":"The date and time of the interaction.","example":"2025-07-17T09:00:00.000Z","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.dateTime","typeLabel":"string\u003cdate-time>"},"url":{"oneOf":[{"type":"string","format":"uri","description":"Always null. This kind of interaction has no link to open in its source.","example":null,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Always null. This kind of interaction has no link to open in its source.","example":null,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.url","typeLabel":"string\u003curi> | null"},"privacyLevel":{"type":"string","enum":["sharedFull","subjectOnly","sensitive","internal"],"description":"Interaction privacy level:\n- `**sharedFull` means the interaction content is fully visible to every workspace member.\n- `**subjectOnly` means the interacton content is hidden for other workspace members.\n- `**sensitve`/`internal` means the interaction is visible only to the workspace members involved in the conversation.\nFor more information about interaction privacy, see our [help center article](https://help.folk.app/en/articles/13056598-security-internal-and-sensitive-interactions)\n","example":"sharedFull","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.privacyLevel","typeLabel":"enum\u003cstring>"},"interactionType":{"type":"string","enum":["whatsapp"],"description":"The interaction is an imported WhatsApp message.","example":"whatsapp","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.interactionType","typeLabel":"enum\u003cstring>"},"from":{"type":"object","properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.from.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The phone number of the participant.","example":"+14155552671","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.from.value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.2.from.name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.2.from.picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.2.from.userId","typeLabel":"string"}},"required":["type","value"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.from","typeLabel":"object"},"to":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.to.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The phone number of the participant.","example":"+14155552671","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.to.items.[INDEX].value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.2.to.items.[INDEX].name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.2.to.items.[INDEX].picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.2.to.items.[INDEX].userId","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.to.items.[INDEX]","typeLabel":"object"},"description":"The recipients of the WhatsApp message.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.to","typeLabel":"object[]"},"content":{"type":"object","properties":{"text":{"type":"string","description":"The message text. Omitted when privacy rules restrict content.","example":"Are we still on for tomorrow?","uniqueKey":"data.\\items.items.[INDEX].oneOf.2.content.text","typeLabel":"string"},"context":{"type":"string","description":"Additional context around the message. Omitted when privacy rules restrict content.","example":"","uniqueKey":"data.\\items.items.[INDEX].oneOf.2.content.context","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.2.content","typeLabel":"object"}},"uniqueKey":"data.\\items.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"An interaction linked to an entity. Can be imported (email, calendar, WhatsApp, call) or manually logged.","required":["id","entity","dateTime","url","privacyLevel","interactionType","from","to","content"],"example":{"id":"lit_b049db09-c03d-4f32-96d6-d314760add5d","interactionType":"logged","entity":{"id":"per_55175e81-9a52-4ac3-930e-82792c23499b","entityType":"person","fullName":"John Doe"},"dateTime":"2025-07-17T09:00:00.000Z","url":null,"privacyLevel":"sharedFull","from":{"type":"user","value":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","name":"John Doe"},"to":{"type":"person","value":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"John Doe"},"content":"Had a coffee with John Doe\nDiscussed the new project."},"properties":{"id":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.id","typeLabel":"string"},"entity":{"type":"object","properties":{"entityType":{"type":"string","enum":["person","company"],"description":"The type of the entity connected to the interaction. Can be `person` or `company`.","example":"person","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.entity.entityType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","minLength":40,"maxLength":40,"description":"The ID of the entity connected to the interaction.","example":"per_55175e81-9a52-4ac3-930e-82792c23499b","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.entity.id","typeLabel":"string"},"fullName":{"type":"string","description":"The full name of the entity connected to the interaction.","example":"John Doe","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.entity.fullName","typeLabel":"string"}},"required":["entityType","id","fullName"],"description":"The entity connected to the interaction.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.entity","typeLabel":"object"},"dateTime":{"type":"string","format":"date-time","description":"The date and time of the interaction.","example":"2025-07-17T09:00:00.000Z","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.dateTime","typeLabel":"string\u003cdate-time>"},"url":{"oneOf":[{"type":"string","format":"uri","description":"Always null. This kind of interaction has no link to open in its source.","example":null,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Always null. This kind of interaction has no link to open in its source.","example":null,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.url","typeLabel":"string\u003curi> | null"},"privacyLevel":{"type":"string","enum":["sharedFull","subjectOnly","sensitive","internal"],"description":"Interaction privacy level:\n- `**sharedFull` means the interaction content is fully visible to every workspace member.\n- `**subjectOnly` means the interacton content is hidden for other workspace members.\n- `**sensitve`/`internal` means the interaction is visible only to the workspace members involved in the conversation.\nFor more information about interaction privacy, see our [help center article](https://help.folk.app/en/articles/13056598-security-internal-and-sensitive-interactions)\n","example":"sharedFull","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.privacyLevel","typeLabel":"enum\u003cstring>"},"interactionType":{"type":"string","enum":["call"],"description":"The interaction is a recorded phone call.","example":"call","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.interactionType","typeLabel":"enum\u003cstring>"},"from":{"type":"object","properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.from.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The phone number of the participant.","example":"+14155552671","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.from.value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.from.name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.from.picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.from.userId","typeLabel":"string"}},"required":["type","value"],"description":"The workspace member who placed the call, through their caller ID.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.from","typeLabel":"object"},"to":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.to.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The phone number of the participant.","example":"+14155552671","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.to.items.[INDEX].value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.to.items.[INDEX].name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.to.items.[INDEX].picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.to.items.[INDEX].userId","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.to.items.[INDEX]","typeLabel":"object"},"description":"The contact who was called. Always a single participant.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.to","typeLabel":"object[]"},"content":{"type":"object","properties":{"status":{"type":"string","enum":["ongoing","processing","completed","missed","failed"],"description":"The status of the call. `ongoing`: the call is ringing or in progress. `processing`: the call has ended and its summary is still being produced. `completed`: the call is over and fully processed. `missed`: the contact did not answer, was busy, or the call was cancelled. `failed`: the call could not be placed or connected.","example":"completed","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.status","typeLabel":"enum\u003cstring>"},"duration":{"type":"integer","minimum":0,"description":"The duration of the call, in seconds.","example":312,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.duration","typeLabel":"integer"},"summary":{"type":"string","description":"The summary of the call. Only returned once the status is `completed`. Omitted when the call was not recorded, when the recording could not be processed, and when privacy rules restrict content.","example":"John confirmed the budget and asked for a proposal by Friday.","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.summary","typeLabel":"string"},"transcript":{"type":"object","properties":{"segments":{"type":"array","items":{"type":"object","properties":{"speaker":{"type":"object","properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].speaker.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The phone number of the participant.","example":"+14155552671","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].speaker.value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].speaker.name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].speaker.picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].speaker.userId","typeLabel":"string"}},"required":["type","value"],"description":"The participant who spoke during the segment. A copy of `from` or of the `to` entry, so match it to a participant by `value`.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].speaker","typeLabel":"object"},"text":{"type":"string","description":"What the speaker said during the segment.","example":"Hi John, thanks for taking the call.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].text","typeLabel":"string"},"start":{"type":"number","description":"When the segment starts, in seconds from the beginning of the call.","example":1.2,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].start","typeLabel":"number"},"end":{"type":"number","description":"When the segment ends, in seconds from the beginning of the call.","example":3.8,"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX].end","typeLabel":"number"}},"required":["speaker","text","start","end"],"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments.items.[INDEX]","typeLabel":"object"},"description":"The transcript of the call, split into speaker-attributed segments in chronological order.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.segments","typeLabel":"object[]"},"language":{"type":"string","description":"The ISO 639-3 code of the language detected during the call, when available.","example":"eng","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript.language","typeLabel":"string"}},"required":["segments"],"description":"The diarized transcript of the call. Only returned by the get interaction endpoint. Omitted when the recording could not be processed, and when privacy rules restrict content.","uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content.transcript","typeLabel":"object"}},"required":["status","duration"],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.3.content","typeLabel":"object"}},"uniqueKey":"data.\\items.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"An interaction linked to an entity. Can be imported (email, calendar, WhatsApp, call) or manually logged.","required":["id","interactionType","from","to","entity","dateTime","title","content","privacyLevel","type","activityType"],"example":{"id":"lit_b049db09-c03d-4f32-96d6-d314760add5d","interactionType":"logged","from":{"type":"user","value":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","name":"John Doe"},"to":{"type":"person","value":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"John Doe"},"title":"Coffee with John Doe","content":"Had a coffee with John Doe\nDiscussed the new project.","entity":{"id":"per_55175e81-9a52-4ac3-930e-82792c23499b","entityType":"person","fullName":"John Doe"},"dateTime":"2025-07-17T09:00:00.000Z","privacyLevel":"sharedFull","type":"coffee","activityType":"coffee"},"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.id","typeLabel":"string"},"interactionType":{"type":"string","enum":["logged"],"description":"The interaction is a manually logged interaction.","example":"logged","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.interactionType","typeLabel":"enum\u003cstring>"},"from":{"oneOf":[{"type":"object","description":"Who logged the interaction. Can be a workspace user or an email sender.","required":["type","value"],"properties":{"type":{"type":"string","enum":["user"],"description":"The interaction was logged by a workspace member.","example":"user","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.0.value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.0.name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.0.picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.0.userId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Who logged the interaction. Can be a workspace user or an email sender.","required":["type","name","value"],"properties":{"type":{"type":"string","enum":["sender"],"description":"The interaction was logged on behalf of an email sender, such as a campaign message.","example":"sender","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.1.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The display name of the sender.","example":"Jane Doe","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.1.name","typeLabel":"string"},"value":{"type":"string","description":"The email address of the sender.","example":"jane@example.com","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.1.value","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.1.picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.1.userId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.from","typeLabel":"object"},"to":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"The type of the entity the interaction is linked to.","enum":["person"],"example":"person","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.to.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The type of the entity the interaction is linked to.","enum":["company"],"example":"person","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.to.type.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.to.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","minLength":40,"maxLength":40,"description":"The ID of the person or company the interaction is linked to.","example":"per_55175e81-9a52-4ac3-930e-82792c23499b","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.to.value","typeLabel":"string"},"name":{"type":"string","description":"The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.","example":"Jane Doe","uniqueKey":"data.\\items.items.[INDEX].oneOf.4.to.name","typeLabel":"string"},"picture":{"type":"string","description":"The picture URL of the matching workspace member or person, if any.","example":"https://example.com/pictures/jane-doe.png","uniqueKey":"data.\\items.items.[INDEX].oneOf.4.to.picture","typeLabel":"string"},"userId":{"type":"string","description":"The workspace member this participant resolves to, if any.","example":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","uniqueKey":"data.\\items.items.[INDEX].oneOf.4.to.userId","typeLabel":"string"}},"required":["type","value"],"description":"The entity the interaction is linked to.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.to","typeLabel":"object"},"entity":{"type":"object","properties":{"entityType":{"type":"string","enum":["person","company"],"description":"The type of the entity connected to the interaction. Can be `person` or `company`.","example":"person","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.entity.entityType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","minLength":40,"maxLength":40,"description":"The ID of the entity connected to the interaction.","example":"per_55175e81-9a52-4ac3-930e-82792c23499b","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.entity.id","typeLabel":"string"},"fullName":{"type":"string","description":"The full name of the entity connected to the interaction.","example":"John Doe","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.entity.fullName","typeLabel":"string"}},"required":["entityType","id","fullName"],"description":"The entity connected to the interaction.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.entity","typeLabel":"object"},"dateTime":{"type":"string","format":"date-time","description":"The date and time of the interaction.","example":"2025-07-17T09:00:00.000Z","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.dateTime","typeLabel":"string\u003cdate-time>"},"title":{"type":"string","description":"The title of the interaction.","example":"Coffee with John Doe","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.title","typeLabel":"string"},"content":{"type":"string","description":"The multi-line content of the interaction.","example":"Had a coffee with John Doe\nDiscussed the new project.","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.content","typeLabel":"string"},"privacyLevel":{"type":"string","enum":["sharedFull"],"description":"Logged interactions always expose their content to authorized users.","example":"sharedFull","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.privacyLevel","typeLabel":"enum\u003cstring>"},"type":{"oneOf":[{"type":"string","description":"Deprecated. Use `activityType` instead.","format":"emoji","maxLength":50,"deprecated":true,"example":"coffee","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.type.oneOf.0","typeLabel":"string\u003cemoji>"},{"type":"string","description":"Deprecated. Use `activityType` instead.","enum":["campaignMessage"],"deprecated":true,"example":"coffee","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.type.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Deprecated. Use `activityType` instead.","deprecated":true,"x-extensible-enum":["call","meeting","message","coffee","lunch","event","drink"],"example":"coffee","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.type.oneOf.2","typeLabel":"string"},{"type":"string","description":"Deprecated. Use `activityType` instead.","deprecated":true,"x-extensible-enum":["whatsapp","twitter","linkedin","instagram","hangout","tiktok","skype","slack","iMessage","fbMessenger","signal","discord","wechat","telegram","viber"],"example":"coffee","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.type.oneOf.3","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.type","typeLabel":"string\u003cemoji> · enum\u003cstring> · string · string"},"activityType":{"oneOf":[{"type":"string","description":"The logged activity type. Can be a predefined activity, a messaging app, or an emoji.","format":"emoji","maxLength":50,"example":"coffee","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.activityType.oneOf.0","typeLabel":"string\u003cemoji>"},{"type":"string","description":"The logged activity type. Can be a predefined activity, a messaging app, or an emoji.","enum":["campaignMessage"],"example":"coffee","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.activityType.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The logged activity type. Can be a predefined activity, a messaging app, or an emoji.","x-extensible-enum":["call","meeting","message","coffee","lunch","event","drink"],"example":"coffee","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.activityType.oneOf.2","typeLabel":"string"},{"type":"string","description":"The logged activity type. Can be a predefined activity, a messaging app, or an emoji.","x-extensible-enum":["whatsapp","twitter","linkedin","instagram","hangout","tiktok","skype","slack","iMessage","fbMessenger","signal","discord","wechat","telegram","viber"],"example":"coffee","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.activityType.oneOf.3","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].oneOf.4.activityType","typeLabel":"string\u003cemoji> · enum\u003cstring> · string · string"}},"uniqueKey":"data.\\items.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"data.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.\\items","typeLabel":"object[]"},"pagination":{"type":"object","properties":{"nextLink":{"type":"string","uniqueKey":"data.pagination.nextLink","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.pagination","typeLabel":"object"}},"required":["items","pagination"],"example":{"items":[{"id":"lit_b049db09-c03d-4f32-96d6-d314760add5d","interactionType":"logged","from":{"type":"user","value":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","name":"John Doe"},"to":{"type":"person","value":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"John Doe"},"entity":{"id":"per_55175e81-9a52-4ac3-930e-82792c23499b","entityType":"person","fullName":"John Doe"},"dateTime":"2025-07-17T09:00:00.000Z","privacyLevel":"sharedFull","title":"Coffee with John Doe","content":"Had a coffee with John Doe\nDiscussed the new project.","type":"coffee","activityType":"coffee"}],"pagination":{"nextLink":"https://api.folk.app/v1/interactions/upcoming?entity.id=per_55175e81-9a52-4ac3-930e-82792c23499b\u0026cursor=eyJmb28iOiJiYXIifQ%3D%3D"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"deprecations":{"type":"array","items":{"type":"string","uniqueKey":"deprecations.items.[INDEX]","typeLabel":"string"},"example":["This field is deprecated"],"uniqueKey":"deprecations","typeLabel":"string[]"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"example":{"data":{"items":[{"id":"lit_b049db09-c03d-4f32-96d6-d314760add5d","interactionType":"logged","from":{"type":"user","value":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","name":"John Doe"},"to":{"type":"person","value":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"John Doe"},"entity":{"id":"per_55175e81-9a52-4ac3-930e-82792c23499b","entityType":"person","fullName":"John Doe"},"dateTime":"2025-07-17T09:00:00.000Z","privacyLevel":"sharedFull","title":"Coffee with John Doe","content":"Had a coffee with John Doe\nDiscussed the new project.","type":"coffee","activityType":"coffee"}],"pagination":{"nextLink":"https://api.folk.app/v1/interactions/upcoming?entity.id=per_55175e81-9a52-4ac3-930e-82792c23499b\u0026cursor=eyJmb28iOiJiYXIifQ%3D%3D"}}},"examples":{"Example":{"title":"Example","value":{"data":{"items":[{"id":"lit_b049db09-c03d-4f32-96d6-d314760add5d","interactionType":"logged","from":{"type":"user","value":"usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c","name":"John Doe"},"to":{"type":"person","value":"per_55175e81-9a52-4ac3-930e-82792c23499b","name":"John Doe"},"entity":{"id":"per_55175e81-9a52-4ac3-930e-82792c23499b","entityType":"person","fullName":"John Doe"},"dateTime":"2025-07-17T09:00:00.000Z","privacyLevel":"sharedFull","title":"Coffee with John Doe","content":"Had a coffee with John Doe\nDiscussed the new project.","type":"coffee","activityType":"coffee"}],"pagination":{"nextLink":"https://api.folk.app/v1/interactions/upcoming?entity.id=per_55175e81-9a52-4ac3-930e-82792c23499b\u0026cursor=eyJmb28iOiJiYXIifQ%3D%3D"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"5d6f5d3d-2ba2-4459-940c-5304d497f659":{"description":"The request was unacceptable, often due to missing an invalid parameter.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_REQUEST","message":"The request was invalid.","documentationUrl":"https://developer.folk.app/api-reference/errors#bad-request","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"The request was invalid.","documentationUrl":"https://developer.folk.app/api-reference/errors#bad-request","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"52ef525d-84d4-44e8-9ffb-6a7191a2a594":{"description":"No valid API key provided.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"No valid API key provided.","documentationUrl":"https://developer.folk.app/api-reference/errors#unauthorized","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"No valid API key provided.","documentationUrl":"https://developer.folk.app/api-reference/errors#unauthorized","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0c88c6f6-c775-4ee5-b24f-f3c7d773d270":{"description":"The API key doesn’t have permissions to perform the request.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"FORBIDDEN","message":"The API key doesn’t have permissions to perform the request.","documentationUrl":"https://developer.folk.app/api-reference/errors#forbidden","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FORBIDDEN","message":"The API key doesn’t have permissions to perform the request.","documentationUrl":"https://developer.folk.app/api-reference/errors#forbidden","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"72c23c1b-c1ef-4b1e-8667-28d4faef8aa5":{"description":"The requested resource doesn’t exist.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RESOURCE_NOT_FOUND","message":"The requested resource was not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RESOURCE_NOT_FOUND","message":"The requested resource was not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"54b9dfac-50ed-471b-a9e4-6b3f1f05de82":{"description":"The request was unacceptable, often due to missing or invalid parameters.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNPROCESSABLE_ENTITY","message":"Invalid query parameters","documentationUrl":"https://developer.folk.app/api-reference/errors#unprocessable-entity","details":{"issues":[{"code":"too_small","minimum":1,"type":"number","inclusive":true,"exact":false,"message":"Number must be greater than or equal to 1","path":["limit"]}]},"requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNPROCESSABLE_ENTITY","message":"Invalid query parameters","documentationUrl":"https://developer.folk.app/api-reference/errors#unprocessable-entity","details":{"issues":[{"code":"too_small","minimum":1,"type":"number","inclusive":true,"exact":false,"message":"Number must be greater than or equal to 1","path":["limit"]}]},"requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"139bb0ca-118a-46d1-8ec5-98ae6b4f9c54":{"description":"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","properties":{"policy":{"type":"string","enum":["default","burst"],"description":"The name of the rate limit policy.","isRequired":true,"uniqueKey":"error.details.policy","typeLabel":"enum\u003cstring>"},"limit":{"type":"integer","description":"The maximum number of requests allowed per window.","isRequired":true,"uniqueKey":"error.details.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"The number of requests remaining in the current window.","isRequired":true,"uniqueKey":"error.details.remaining","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The length of the window, in seconds.","isRequired":true,"uniqueKey":"error.details.windowSeconds","typeLabel":"integer"},"retryAfter":{"type":"string","format":"date-time","description":"When the current window resets.","isRequired":true,"uniqueKey":"error.details.retryAfter","typeLabel":"string\u003cdate-time>"},"policies":{"type":"array","items":{"type":"object","properties":{"policy":{"type":"string","enum":["default","burst"],"description":"The name of the rate limit policy.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].policy","typeLabel":"enum\u003cstring>"},"limit":{"type":"integer","description":"The maximum number of requests allowed per window.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"The number of requests remaining in the current window.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].remaining","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The length of the window, in seconds.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].windowSeconds","typeLabel":"integer"},"retryAfter":{"type":"string","format":"date-time","description":"When the current window resets.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].retryAfter","typeLabel":"string\u003cdate-time>"}},"required":["policy","limit","remaining","windowSeconds","retryAfter"],"uniqueKey":"error.details.policies.items.[INDEX]","typeLabel":"object"},"description":"The status of every rate limit policy applied to the request.","isRequired":true,"uniqueKey":"error.details.policies","typeLabel":"object[]"}},"required":["policy","limit","remaining","windowSeconds","retryAfter","policies"],"description":"The exceeded rate limit policy. When several are exceeded, the one resetting last.","isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response returned when a rate limit is exceeded.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"TOO_MANY_REQUESTS","message":"You have exceeded your rate limit.","documentationUrl":"https://developer.folk.app/api-reference/errors#rate-limiting","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z","details":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z","policies":[{"policy":"default","limit":600,"remaining":412,"windowSeconds":60,"retryAfter":"2025-10-01T12:01:00.000Z"},{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"}]}}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"TOO_MANY_REQUESTS","message":"You have exceeded your rate limit.","documentationUrl":"https://developer.folk.app/api-reference/errors#rate-limiting","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z","details":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z","policies":[{"policy":"default","limit":600,"remaining":412,"windowSeconds":60,"retryAfter":"2025-10-01T12:01:00.000Z"},{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"}]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"d0060b01-0177-4659-8fc5-3370bb8f40bf":{"description":"Something went wrong on our end.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"An internal server error occurred.","documentationUrl":"https://developer.folk.app/api-reference/errors#internal-server-error","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"An internal server error occurred.","documentationUrl":"https://developer.folk.app/api-reference/errors#internal-server-error","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"e085b8b0-33c3-45ae-b2c5-3fe683fcf147":{"description":"The server is overloaded or down for maintenance.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SERVICE_UNAVAILABLE","message":"The service is currently unavailable.","documentationUrl":"https://developer.folk.app/api-reference/errors#service-unavailable","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SERVICE_UNAVAILABLE","message":"The service is currently unavailable.","documentationUrl":"https://developer.folk.app/api-reference/errors#service-unavailable","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"94681b7a-14ac-4f35-b567-788b1f8bc348":{"bearerApiKeyAuth":{"type":"http","scheme":"bearer","description":"API key for authentication","scopes":[],"schemeName":"bearerApiKeyAuth"}}},"servers":{"4a52fd1c-f45c-4b69-88e2-0ac14d254310":{"url":"https://api.folk.app","description":"Folk's public API production base URL.","x-internal":false}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key for authentication","scopes":[],"schemeName":"bearerApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key for authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerApiKeyAuth","name":"Authorization"}],"title":"bearerApiKeyAuth"}]},"originalFileLocation":"schemas/2025-06-09.json"},"subdomain":"folk-cf968f5e","siteName":"Folk Developer Portal","title":"(Beta) List upcoming interactions - Folk Developer Portal","navMaps":{"firstHrefInVersion":{"2025-06-09":{"href":"/api-reference/interactions/list-upcoming-interactions","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T16:23:02.405Z","originalFileLocation":"api-reference/interactions/list-upcoming-interactions.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=\"Retrieves paginated upcoming interactions linked to a person, company, or object.This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"(Beta) List upcoming interactions - Folk Developer Portal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves paginated upcoming interactions linked to a person, company, or object.This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://folk-cf968f5e.mintlify.app/_mintlify/api/og/v2?division=Interactions\u0026amp;title=%28Beta%29+List+upcoming+interactions\u0026amp;description=Retrieves+paginated+upcoming+interactions+linked+to+a+person%2C+company%2C+or+object.%3Cbr%2F%3E%3CWarning%3EThis+endpoint+is+currently+in+open+beta.+The+API+surface+may+chan\u0026amp;theme=85df8d899a1a67ad96f0c424\u0026amp;signature=d5bb634168e5d34c0caa508171a204fa65f9c88264e77c4cd3baaad12c45af06\">\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=\"(Beta) List upcoming interactions - Folk Developer Portal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves paginated upcoming interactions linked to a person, company, or object.This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://folk-cf968f5e.mintlify.app/_mintlify/api/og/v2?division=Interactions\u0026amp;title=%28Beta%29+List+upcoming+interactions\u0026amp;description=Retrieves+paginated+upcoming+interactions+linked+to+a+person%2C+company%2C+or+object.%3Cbr%2F%3E%3CWarning%3EThis+endpoint+is+currently+in+open+beta.+The+API+surface+may+chan\u0026amp;theme=85df8d899a1a67ad96f0c424\u0026amp;signature=d5bb634168e5d34c0caa508171a204fa65f9c88264e77c4cd3baaad12c45af06\">\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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/interactions/list-upcoming-interactions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.folk.app/#organization\",\"name\":\"Folk Developer Portal\",\"url\":\"https://developer.folk.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=08eda1dcbb1eefceac8ca5fea9c103d8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.folk.app#website\",\"name\":\"Folk Developer Portal\",\"url\":\"https://developer.folk.app\",\"publisher\":{\"@id\":\"https://developer.folk.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions#webpage\",\"url\":\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions\",\"name\":\"(Beta) List upcoming interactions\",\"description\":\"Retrieves paginated upcoming interactions linked to a person, company, or object.This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\",\"dateModified\":\"2026-11-03T16:23:02.405Z\",\"isPartOf\":{\"@id\":\"https://developer.folk.app#website\"},\"breadcrumb\":{\"@id\":\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Available endpoints\",\"item\":\"https://developer.folk.app/api-reference/people/list-people\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Interactions\",\"item\":\"https://developer.folk.app/api-reference/interactions/list-interactions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"(Beta) List upcoming interactions\",\"item\":\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions#apireference\",\"headline\":\"(Beta) List upcoming interactions\",\"name\":\"(Beta) List upcoming interactions\",\"description\":\"Retrieves paginated upcoming interactions linked to a person, company, or object.This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\",\"url\":\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions\",\"mainEntityOfPage\":{\"@id\":\"https://developer.folk.app/api-reference/interactions/list-upcoming-interactions#webpage\"},\"dateModified\":\"2026-11-03T16:23:02.405Z\",\"publisher\":{\"@id\":\"https://developer.folk.app/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.folk.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Folk Developer Portal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Folk Developer Portal","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/quick-start"}]},{"tab":"API Reference","versions":[{"version":"2025-06-09","default":true,"groups":[{"group":"Introduction","pages":[{"title":null,"href":"/api-reference/overview"},{"title":null,"href":"/api-reference/authentication"},{"title":null,"href":"/api-reference/success-responses"},{"title":null,"href":"/api-reference/errors"},{"title":null,"href":"/api-reference/pagination"},{"title":null,"href":"/api-reference/filtering"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Batch requests","href":"/api-reference/batch-requests"},{"title":null,"href":"/api-reference/rate-limits"},{"title":"Request ID","href":"/api-reference/request-id"},{"title":null,"href":"/api-reference/versioning"}]},{"group":"Available endpoints","pages":[{"group":"People","pages":[{"title":"List people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/people","href":"/api-reference/people/list-people"},{"openapi":"post /v1/people","title":"Create a person","href":"/api-reference/people/create-a-person"},{"title":"Get a person","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/people/{personId}","href":"/api-reference/people/get-a-person"},{"openapi":"patch /v1/people/{personId}","title":"Update a person","href":"/api-reference/people/update-a-person"},{"openapi":"delete /v1/people/{personId}","title":"Delete a person","href":"/api-reference/people/delete-a-person"},{"openapi":"post /v1/people/batch/create","title":"Create people in batch","href":"/api-reference/people/create-people-in-batch"},{"openapi":"post /v1/people/batch/update","title":"Update people in batch","href":"/api-reference/people/update-people-in-batch"},{"openapi":"post /v1/people/batch/delete","title":"Delete people in batch","href":"/api-reference/people/delete-people-in-batch"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/companies","href":"/api-reference/companies/list-companies"},{"openapi":"post /v1/companies","title":"Create a company","href":"/api-reference/companies/create-a-company"},{"title":"Get a company","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/companies/{companyId}","href":"/api-reference/companies/get-a-company"},{"openapi":"patch /v1/companies/{companyId}","title":"Update a company","href":"/api-reference/companies/update-a-company"},{"openapi":"delete /v1/companies/{companyId}","title":"Delete a company","href":"/api-reference/companies/delete-a-company"},{"openapi":"post /v1/companies/batch/create","title":"Create companies in batch","href":"/api-reference/companies/create-companies-in-batch"},{"openapi":"post /v1/companies/batch/update","title":"Update companies in batch","href":"/api-reference/companies/update-companies-in-batch"},{"openapi":"post /v1/companies/batch/delete","title":"Delete companies in batch","href":"/api-reference/companies/delete-companies-in-batch"}]},{"group":"Credits","pages":[{"title":"Get credits","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/credits","href":"/api-reference/credits/get-credits"}]},{"group":"Group members","pages":[{"title":"List group members","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/members","href":"/api-reference/group-members/list-group-members"},{"title":"Add a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups/{groupId}/members","href":"/api-reference/group-members/add-a-group-member"},{"title":"Update a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}/members/{userId}","href":"/api-reference/group-members/update-a-group-member"},{"title":"Remove a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/groups/{groupId}/members/{userId}","href":"/api-reference/group-members/remove-a-group-member"}]},{"group":"Group custom fields","pages":[{"title":"List group custom fields","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/custom-fields/{entityType}","href":"/api-reference/group-custom-fields/list-group-custom-fields"},{"title":"Create a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups/{groupId}/custom-fields/{entityType}","href":"/api-reference/group-custom-fields/create-a-group-custom-field"},{"title":"Get a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/custom-fields/{entityType}/{customFieldName}","href":"/api-reference/group-custom-fields/get-a-group-custom-field"},{"title":"Update a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}/custom-fields/{entityType}/{customFieldName}","href":"/api-reference/group-custom-fields/update-a-group-custom-field"}]},{"group":"Custom objects","pages":[{"openapi":"get /v1/groups/{groupId}/{objectType}","title":"List objects","href":"/api-reference/custom-objects/list-objects"},{"openapi":"post /v1/groups/{groupId}/{objectType}","title":"Create an object","href":"/api-reference/custom-objects/create-an-object"},{"openapi":"get /v1/groups/{groupId}/{objectType}/{objectId}","title":"Get an object","href":"/api-reference/custom-objects/get-an-object"},{"openapi":"patch /v1/groups/{groupId}/{objectType}/{objectId}","title":"Update an object","href":"/api-reference/custom-objects/update-an-object"},{"openapi":"delete /v1/groups/{groupId}/{objectType}/{objectId}","title":"Delete an object","href":"/api-reference/custom-objects/delete-an-object"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/create","title":"Create objects in batch","href":"/api-reference/custom-objects/create-objects-in-batch"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/update","title":"Update objects in batch","href":"/api-reference/custom-objects/update-objects-in-batch"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/delete","title":"Delete objects in batch","href":"/api-reference/custom-objects/delete-objects-in-batch"}]},{"group":"Groups","pages":[{"title":"List groups","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups","href":"/api-reference/groups/list-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups","href":"/api-reference/groups/create-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}","href":"/api-reference/groups/update-a-group"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users","href":"/api-reference/users/list-users"},{"title":"Get the current user","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users/me","href":"/api-reference/users/get-the-current-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users/{userId}","href":"/api-reference/users/get-a-user"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/notes","href":"/api-reference/notes/list-notes"},{"openapi":"post /v1/notes","title":"Create a note","href":"/api-reference/notes/create-a-note"},{"title":"Get a note","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/notes/{noteId}","href":"/api-reference/notes/get-a-note"},{"openapi":"patch /v1/notes/{noteId}","title":"Update a note","href":"/api-reference/notes/update-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/notes/{noteId}","href":"/api-reference/notes/delete-a-note"}]},{"group":"Reminders","pages":[{"title":"List reminders","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/reminders","href":"/api-reference/reminders/list-reminders"},{"openapi":"post /v1/reminders","deprecated":true,"title":"Create a reminder","href":"/api-reference/reminders/create-a-reminder"},{"title":"Get a reminder","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/reminders/{reminderId}","href":"/api-reference/reminders/get-a-reminder"},{"openapi":"patch /v1/reminders/{reminderId}","deprecated":true,"title":"Update a reminder","href":"/api-reference/reminders/update-a-reminder"},{"title":"Delete a reminder","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/reminders/{reminderId}","href":"/api-reference/reminders/delete-a-reminder"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/tasks/{taskId}","href":"/api-reference/tasks/get-a-task"},{"openapi":"patch /v1/tasks/{taskId}","title":"Update a task","href":"/api-reference/tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/tasks/{taskId}","href":"/api-reference/tasks/delete-a-task"},{"title":"Mark a task as done","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks/{taskId}/mark-as-done","href":"/api-reference/tasks/mark-a-task-as-done"},{"title":"Mark a task as to do","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks/{taskId}/mark-as-todo","href":"/api-reference/tasks/mark-a-task-as-to-do"}]},{"group":"Person enrichments","pages":[{"title":"List enrichments of people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/person-enrichments","href":"/api-reference/person-enrichments/list-enrichments-of-people"},{"openapi":"post /v1/person-enrichments","title":"Enrich people","href":"/api-reference/person-enrichments/enrich-people"},{"title":"Get an enrichment of people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/person-enrichments/{enrichmentId}","href":"/api-reference/person-enrichments/get-an-enrichment-of-people"}]},{"group":"Interactions","pages":[{"title":"(Beta) List interactions","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions","href":"/api-reference/interactions/list-interactions"},{"title":"Create an interaction","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/interactions","href":"/api-reference/interactions/create-an-interaction"},{"title":"(Beta) List past interactions","description":"Retrieves paginated past interactions linked to a person, company, or object.\u003cbr/>\u003cWarning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.\u003c/Warning>\u003cbr/>\u003cWarning>This endpoint is deprecated since September 29, 2026 and will be removed on March 29, 2027. Please use the List interactions endpoint instead.\u003c/Warning>","deprecated":true,"version":null,"tag":"Beta","sidebarTitle":"List past interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions/past","href":"/api-reference/interactions/list-past-interactions"},{"title":"(Beta) List upcoming interactions","deprecated":true,"version":null,"tag":"Beta","sidebarTitle":"List upcoming interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions/upcoming","href":"/api-reference/interactions/list-upcoming-interactions"},{"title":"(Beta) Get a past or upcoming interaction","description":"Retrieves a single interaction. Full email or calendar body is included when privacy rules allow it.\u003cbr/>\u003cWarning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.\u003c/Warning>","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a past or upcoming interaction","openapi":"/schemas/2025-06-09.json get /v1/interactions/{interactionId}","href":"/api-reference/interactions/get-a-past-or-upcoming-interaction"},{"title":"(Beta) Update an interaction","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update an interaction","openapi":"/schemas/2025-06-09.json patch /v1/interactions/{interactionId}","href":"/api-reference/interactions/update-an-interaction"},{"title":"(Beta) Delete an interaction","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Delete an interaction","openapi":"/schemas/2025-06-09.json delete /v1/interactions/{interactionId}","href":"/api-reference/interactions/delete-an-interaction"}]},{"group":"Webhooks","pages":[{"openapi":"get /v1/webhooks","title":"List webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"post /v1/webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"get /v1/webhooks/{webhookId}","title":"Get a webhook","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"patch /v1/webhooks/{webhookId}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"},{"openapi":"delete /v1/webhooks/{webhookId}","title":"Delete a webhook","href":"/api-reference/webhooks/delete-a-webhook"}]},{"group":"Campaigns","pages":[{"title":"(Beta) List campaigns","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List campaigns","openapi":"/schemas/2025-06-09.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"(Beta) Create a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Create a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"(Beta) Get a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/get-a-campaign"},{"title":"(Beta) Update a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update a campaign","openapi":"/schemas/2025-06-09.json patch /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/update-a-campaign"},{"title":"(Beta) Delete a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Delete a campaign","openapi":"/schemas/2025-06-09.json delete /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/delete-a-campaign"},{"title":"(Beta) List the messages of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List the messages of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/messages","href":"/api-reference/campaigns/list-the-messages-of-a-campaign"},{"title":"(Beta) Get a message of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a message of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/messages/{messageId}","href":"/api-reference/campaigns/get-a-message-of-a-campaign"},{"title":"(Beta) Update a message of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update a message of a campaign","openapi":"/schemas/2025-06-09.json patch /v1/campaigns/{campaignId}/messages/{messageId}","href":"/api-reference/campaigns/update-a-message-of-a-campaign"},{"title":"(Beta) List the variables of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List the variables of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/variables","href":"/api-reference/campaigns/list-the-variables-of-a-campaign"},{"title":"(Beta) Stop a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Stop a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/stop","href":"/api-reference/campaigns/stop-a-campaign"},{"title":"(Beta) Review a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Review a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/review","href":"/api-reference/campaigns/review-a-campaign"},{"title":"(Beta) Put a campaign back to draft","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Put a campaign back to draft","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/draft","href":"/api-reference/campaigns/put-a-campaign-back-to-draft"},{"title":"(Beta) Update messages of a campaign in batch","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update messages of a campaign in batch","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/messages/batch/update","href":"/api-reference/campaigns/update-messages-of-a-campaign-in-batch"},{"title":"(Beta) Remove a recipient from a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Remove a recipient from a campaign","openapi":"/schemas/2025-06-09.json delete /v1/campaigns/{campaignId}/recipients/{contactId}","href":"/api-reference/campaigns/remove-a-recipient-from-a-campaign"},{"title":"(Beta) List message senders","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List message senders","openapi":"/schemas/2025-06-09.json get /v1/message-senders","href":"/api-reference/campaigns/list-message-senders"}]}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Roadmap","pages":[{"title":"Roadmap","href":"/roadmap"}]}]},"basePath":"","title":"(Beta) List upcoming interactions - Folk Developer Portal","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}