Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.
Optional; false by default. Include classification from stored or retained diagnostic evidence on this page. Historical events are unchanged. An unknown category means evidence is missing, unmatched, or ambiguous; severity and finality describe the recorded failure.
Present only when include_bounce_classification=true. The unknown category is shown as Unclassified; severity and finality do not imply inbox placement.
Diagnostic cause identifier. The UI labels unknown as Unclassified and dns_routing_error as DNS or routing error. Unknown is the fallback when evidence does not establish a cause.
Whether this event establishes a delivery-final failure. A temporary code without retry-exhaustion proof is non-final, even if the original sending process stopped. False also includes unconfirmed outcomes; it does not establish successful delivery or promise an automatic retry.
{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}
{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}
{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}
{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}
{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}
{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}
{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}
{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Spotzee","description":"All-in-one growth platform for CRM, campaigns, automation and practical growth tools","colors":{"primary":"#6a75f1","light":"#5a84e9","dark":"#004aad"},"logo":{"light":"https://mintcdn.com/spotzee/27QeIXddlVEQEUZJ/images/logo-light.svg?fit=max\u0026auto=format\u0026n=27QeIXddlVEQEUZJ\u0026q=85\u0026s=8db9a62cf5f9d992c6d6246a633e0e82","dark":"https://mintcdn.com/spotzee/27QeIXddlVEQEUZJ/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=27QeIXddlVEQEUZJ\u0026q=85\u0026s=9183737c2641c9b024bfba95653c9069","href":"https://spotzee.com/docs"},"favicon":"https://mintcdn.com/spotzee/27QeIXddlVEQEUZJ/favicon.svg?fit=max\u0026auto=format\u0026n=27QeIXddlVEQEUZJ\u0026q=85\u0026s=686d07db61778b8982ed9b1b242dc519","api":{"params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript","go"],"autogenerate":true}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"https://spotzee.com","label":"Website"}],"primary":{"type":"button","label":"App","href":"https://app.spotzee.com"}},"footer":{"socials":{"x":"https://www.twitter.com/spotzeemarketin","linkedin":"https://www.linkedin.com/company/spotzee-marketing","facebook":"https://www.facebook.com/spotzeemarketing","github":"https://github.com/spotzee-marketing","youtube":"https://www.youtube.com/@spotzeemarketing"}},"seo":{"metatags":{"canonical":"https://spotzee.com/docs"}},"fonts":{"family":"Lato","weight":400},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"App","icon":"gauge","href":"https://app.spotzee.com"},{"anchor":"Website","icon":"globe","href":"https://spotzee.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spotzee","hasAudioNarration":false,"actualSubdomain":"spotzee","customDomains":["spotzee.com"],"gitSource":{"type":"github","owner":"spotzee-marketing","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af52b0f309c06bed4af4501","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Guides","count":134},{"language":"default","tag":"Main API","count":111},{"language":"default","tag":"Tools","count":65},{"language":"default","tag":"Extended API","count":58},{"language":"default","tag":"Data","count":29},{"language":"default","tag":"Data generation","count":28},{"language":"default","tag":"Email","count":18},{"language":"default","tag":"Integrate","count":16},{"language":"default","tag":"SDKs","count":16},{"language":"default","tag":"CRM","count":15}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{font-size:105%}.antialiased{-webkit-font-smoothing:auto!important;-moz-osx-font-smoothing:auto!important}.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6,.prose h1,.prose h2,.prose h3,.prose h4,.prose h5,.prose h6{letter-spacing:var(--tracking-tight)!important}body,.prose,.prose p,.prose li,.prose td,.prose th,.prose blockquote{letter-spacing:0.00625rem!important}#sidebar-title{color:rgb(var(--gray-500));text-transform:uppercase;font-size:80%;letter-spacing:0.01875rem!important}.callout .text-sm{font-size:0.975rem!important;line-height:1.35rem!important}"}],"page":{"pagePath":"api/events/list-events","slug":"/api/events/list-events","pageMetadata":{"title":"List events","description":"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /events","href":"/api/events/list-events","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List events","description":"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /events","href":"/api/events/list-events","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listEvents","summary":"List events","description":"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.","tags":["Events"],"security":["7ae32540-bf87-41c2-a2e8-c1d8d60b3353"],"servers":["dabdc8e4-808c-4d81-a469-9a63571a0a73"],"parameters":["2932624f-dc7e-4186-a850-2e4e53cbf7ee","c9ae0f52-1039-4bd2-803b-4a3031de4bba","dcb3cea9-64d9-409e-8685-34b0444a531e","9cb989d7-9445-44b8-a9f3-3d32ad93f38a","b4f3dc2d-7614-4123-a5a7-43b39bc810f2","6d1bf33d-178e-4935-9b33-265bb3f1544b","aa92c5e1-430f-4a5e-833b-3e7849718a9c","87130755-10c3-48d4-86e4-2040aebd41c0","7c9a5f0d-ce75-498d-bd4a-fbc00ee6f7cb","7441c005-996a-426b-8b53-fcf102dcb518","ab547eba-658f-4e19-823c-f666b2363efe"],"responses":{"200":"c8811376-83ff-4a73-9d5c-129355fcbd06","400":"c0cc79af-2edd-47f4-b1de-35f423c6ea8a","401":"28f8cefd-156e-46ae-b9a9-4aa1e43793b1","403":"a9f6a74c-c54b-48f8-b8d6-57323b3ba01c","404":"f8b98d9a-fb47-4ccf-a923-50e6078debe9","409":"72702aef-8f7d-4038-afd8-9d614ad3ae56","422":"907160ac-1ae4-4a9c-b76b-b31489cfa000","429":"4a25455c-19d7-474d-a217-e35802a16c8b","500":"e3a1e6ab-d8b6-45a6-a4af-5e41ee86ec62"},"method":"get","type":"path","path":"/events","baseUrlOptions":["https://apix.spotzee.com/api/client"],"title":"List events","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2932624f-dc7e-4186-a850-2e4e53cbf7ee":{"schema":{"type":"string","format":"date-time","description":"Inclusive RFC 3339 start time.","example":"2026-04-28T00:00:00.000Z","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":true,"description":"Inclusive RFC 3339 start time.","name":"from","in":"query"},"c9ae0f52-1039-4bd2-803b-4a3031de4bba":{"schema":{"type":"string","format":"date-time","description":"Exclusive RFC 3339 end time.","example":"2026-04-29T00:00:00.000Z","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":true,"description":"Exclusive RFC 3339 end time.","name":"to","in":"query"},"dcb3cea9-64d9-409e-8685-34b0444a531e":{"schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"items.[INDEX]","typeLabel":"string"},"maxItems":100,"description":"Filter to one or more system-of-record user identifiers.","example":["cust-9f4b21"],"isRequired":false,"uniqueKey":"","typeLabel":"string[]"},"required":false,"description":"Filter to one or more system-of-record user identifiers.","name":"external_id","in":"query"},"9cb989d7-9445-44b8-a9f3-3d32ad93f38a":{"schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"items.[INDEX]","typeLabel":"string"},"maxItems":100,"description":"Filter to one or more anonymous tracking identifiers.","example":["anon-2c8a3e"],"isRequired":false,"uniqueKey":"","typeLabel":"string[]"},"required":false,"description":"Filter to one or more anonymous tracking identifiers.","name":"anonymous_id","in":"query"},"b4f3dc2d-7614-4123-a5a7-43b39bc810f2":{"schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"items.[INDEX]","typeLabel":"string"},"maxItems":50,"description":"Filter to one or more event names.","example":["order_completed"],"isRequired":false,"uniqueKey":"","typeLabel":"string[]"},"required":false,"description":"Filter to one or more event names.","name":"event_name","in":"query"},"6d1bf33d-178e-4935-9b33-265bb3f1544b":{"schema":{"type":"array","items":{"type":"integer","exclusiveMinimum":0,"uniqueKey":"items.[INDEX]","typeLabel":"integer"},"maxItems":25,"description":"Filter to one or more numeric campaign identifiers.","example":[123],"isRequired":false,"uniqueKey":"","typeLabel":"integer[]"},"required":false,"description":"Filter to one or more numeric campaign identifiers.","name":"campaign_id","in":"query"},"aa92c5e1-430f-4a5e-833b-3e7849718a9c":{"schema":{"type":"boolean","description":"Optional; false by default. Include classification from stored or retained diagnostic evidence on this page. Historical events are unchanged. An unknown category means evidence is missing, unmatched, or ambiguous; severity and finality describe the recorded failure.","isRequired":false,"uniqueKey":"","typeLabel":"boolean"},"required":false,"description":"Optional; false by default. Include classification from stored or retained diagnostic evidence on this page. Historical events are unchanged. An unknown category means evidence is missing, unmatched, or ambiguous; severity and finality describe the recorded failure.","name":"include_bounce_classification","in":"query"},"87130755-10c3-48d4-86e4-2040aebd41c0":{"schema":{"type":"boolean","default":true,"description":"Include the event payload in each result. Defaults to `true`; set `false` to omit payloads.","example":true,"isRequired":false,"uniqueKey":"","typeLabel":"boolean"},"required":false,"description":"Include the event payload in each result. Defaults to `true`; set `false` to omit payloads.","name":"include_payload","in":"query"},"7c9a5f0d-ce75-498d-bd4a-fbc00ee6f7cb":{"schema":{"type":"string","maxLength":2048,"description":"Opaque cursor returned by a previous page. Omit on the first request.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Opaque cursor returned by a previous page. Omit on the first request.","name":"cursor","in":"query"},"7441c005-996a-426b-8b53-fcf102dcb518":{"schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Maximum events to return. The maximum page size is 100.","example":50,"isRequired":false,"uniqueKey":"","typeLabel":"integer"},"required":false,"description":"Maximum events to return. The maximum page size is 100.","name":"limit","in":"query"},"ab547eba-658f-4e19-823c-f666b2363efe":{"schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Event order by occurrence time.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Event order by occurrence time.","name":"direction","in":"query"}},"responses":{"c8811376-83ff-4a73-9d5c-129355fcbd06":{"description":"A page of matching events.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^evt_[0-9A-HJKMNP-TV-Z]{26}$","description":"Stable, opaque identifier prefixed with `evt_`.","example":"evt_01HXY7Z9K8M5J2N4P6Q8R0S1T2","isRequired":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Event name.","example":"order_completed","isRequired":true,"uniqueKey":"results.items.[INDEX].name","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"Time the event occurred.","example":"2026-04-28T05:14:00.000Z","isRequired":true,"uniqueKey":"results.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"user":{"type":"object","properties":{"external_id":{"oneOf":[{"type":"string","description":"System-of-record user identifier, when available.","example":"cust-9f4b21","isRequired":true,"uniqueKey":"results.items.[INDEX].user.external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"System-of-record user identifier, when available.","example":"cust-9f4b21","isRequired":true,"uniqueKey":"results.items.[INDEX].user.external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].user.external_id","typeLabel":"string | null"},"anonymous_id":{"oneOf":[{"type":"string","description":"Anonymous tracking identifier, when available.","example":"anon-2c8a3e","isRequired":true,"uniqueKey":"results.items.[INDEX].user.anonymous_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Anonymous tracking identifier, when available.","example":"anon-2c8a3e","isRequired":true,"uniqueKey":"results.items.[INDEX].user.anonymous_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].user.anonymous_id","typeLabel":"string | null"}},"required":["external_id","anonymous_id"],"isRequired":true,"uniqueKey":"results.items.[INDEX].user","typeLabel":"object"},"campaign_id":{"oneOf":[{"type":"integer","description":"Campaign identifier when the event belongs to a campaign.","example":123,"isRequired":true,"uniqueKey":"results.items.[INDEX].campaign_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Campaign identifier when the event belongs to a campaign.","example":123,"isRequired":true,"uniqueKey":"results.items.[INDEX].campaign_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].campaign_id","typeLabel":"integer | null"},"bounce_classification":{"type":"object","properties":{"category":{"type":"string","enum":["invalid_recipient","mailbox_unavailable","mailbox_full","authentication_failed","policy_blocked","spam_rejected","reputation_blocked","rate_limited","content_rejected","dns_routing_error","transport_error","unknown"],"description":"Diagnostic cause identifier. The UI labels unknown as Unclassified and dns_routing_error as DNS or routing error. Unknown is the fallback when evidence does not establish a cause.","isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.category","typeLabel":"enum\u003cstring>"},"severity":{"type":"string","enum":["temporary","permanent","unknown"],"description":"Severity of the diagnostic evidence, independent of finality. A temporary diagnostic can accompany a final outcome.","isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.severity","typeLabel":"enum\u003cstring>"},"final":{"type":"boolean","description":"Whether this event establishes a delivery-final failure. A temporary code without retry-exhaustion proof is non-final, even if the original sending process stopped. False also includes unconfirmed outcomes; it does not establish successful delivery or promise an automatic retry.","isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.final","typeLabel":"boolean"},"diagnostic":{"type":"string","maxLength":2048,"isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.diagnostic","typeLabel":"string"},"ruleset":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.ruleset","typeLabel":"string"},"rule_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.rule_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.rule_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.rule_id","typeLabel":"string | null"},"source_evidence":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"results.items.[INDEX].bounce_classification.source_evidence.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.source_evidence","typeLabel":"object"},"classified_at":{"type":"string","format":"date-time","description":"When the classification was produced; not the event occurrence time or report freshness timestamp.","isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.classified_at","typeLabel":"string\u003cdate-time>"},"reason":{"type":"string","enum":["matched","unmatched","missing_evidence","ambiguous","not_a_bounce"],"description":"Why the diagnostic matched a cause or remained unknown. Missing, unmatched and ambiguous evidence must not be treated as delivery success.","isRequired":true,"uniqueKey":"results.items.[INDEX].bounce_classification.reason","typeLabel":"enum\u003cstring>"}},"required":["category","severity","final","diagnostic","ruleset","rule_id","source_evidence","classified_at","reason"],"additionalProperties":false,"description":"Present only when `include_bounce_classification=true`. The `unknown` category is shown as Unclassified; severity and finality do not imply inbox placement.","uniqueKey":"results.items.[INDEX].bounce_classification","typeLabel":"object"},"data":{"type":"object","additionalProperties":true,"description":"Event payload. Present when `include_payload=true`.","example":{"order_id":"ord-2048","total":199,"currency":"AUD"},"uniqueKey":"results.items.[INDEX].data","typeLabel":"object"}},"required":["id","name","created_at","user","campaign_id"],"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"nextCursor":{"oneOf":[{"type":"string","description":"Cursor for the next page, or `null` when there is no next page.","isRequired":true,"uniqueKey":"nextCursor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cursor for the next page, or `null` when there is no next page.","isRequired":true,"uniqueKey":"nextCursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nextCursor","typeLabel":"string | null"},"prevCursor":{"oneOf":[{"type":"string","description":"Cursor for the previous page, or `null` when there is no previous page.","isRequired":true,"uniqueKey":"prevCursor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cursor for the previous page, or `null` when there is no previous page.","isRequired":true,"uniqueKey":"prevCursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"prevCursor","typeLabel":"string | null"},"limit":{"type":"integer","description":"Page size used for the response.","example":50,"isRequired":true,"uniqueKey":"limit","typeLabel":"integer"}},"required":["results","nextCursor","prevCursor","limit"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"results":[{"id":"evt_01HXY7Z9K8M5J2N4P6Q8R0S1T2","name":"order_completed","created_at":"2026-04-28T05:14:00.000Z","user":{"external_id":"cust-9f4b21","anonymous_id":"anon-2c8a3e"},"campaign_id":123,"bounce_classification":{"category":"invalid_recipient","severity":"temporary","final":true,"diagnostic":"\u003cstring>","ruleset":"\u003cstring>","rule_id":"\u003cstring>","source_evidence":{},"classified_at":"2023-11-07T05:31:56Z","reason":"matched"},"data":{"order_id":"ord-2048","total":199,"currency":"AUD"}}],"nextCursor":"\u003cstring>","prevCursor":"\u003cstring>","limit":50}}},"exampleType":"generated"}},"exampleType":"generated"},"c0cc79af-2edd-47f4-b1de-35f423c6ea8a":{"description":"Malformed request — bad parameters, body, or version header.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Constant marker indicating this payload is an error response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"description":"Stable, machine-readable error code. Safe to switch on; never localised.","example":"resource_missing","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, en-AU explanation. May include identifiers.","example":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Legacy human-readable mirror of `message`. Retained while in-product clients migrate; new integrations should read `message`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"title":{"type":"string","description":"Short, human-readable summary suitable for a heading. en-AU.","example":"Resource missing","uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"Documentation URL for this error class (RFC 7807).","example":"https://docs.spotzee.com/main-api/errors#resource_missing","uniqueKey":"type","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Server-generated correlation ID. Echoed in the X-Request-ID response header.","example":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","uniqueKey":"request_id","typeLabel":"string"},"param":{"type":"string","description":"Name of the offending parameter, when a single field is at fault.","example":"id","uniqueKey":"param","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"Dotted path to the offending request field.","example":"email","isRequired":true,"uniqueKey":"errors.items.[INDEX].param","typeLabel":"string"},"code":{"type":"string","description":"Per-field error code.","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"example":"parameter_invalid_format","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, English (en-AU) explanation of this field error.","example":"Must be a valid email address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["param","code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Field-level errors when multiple parameters fail validation.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","code","message","error"],"description":"Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as `application/problem+json`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"resource_missing","message":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","error":"\u003cstring>","title":"Resource missing","type":"https://docs.spotzee.com/main-api/errors#resource_missing","request_id":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","param":"id","errors":[{"param":"email","code":"parameter_invalid_format","message":"Must be a valid email address."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"28f8cefd-156e-46ae-b9a9-4aa1e43793b1":{"description":"Authentication required or the supplied API key is invalid.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Constant marker indicating this payload is an error response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"description":"Stable, machine-readable error code. Safe to switch on; never localised.","example":"resource_missing","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, en-AU explanation. May include identifiers.","example":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Legacy human-readable mirror of `message`. Retained while in-product clients migrate; new integrations should read `message`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"title":{"type":"string","description":"Short, human-readable summary suitable for a heading. en-AU.","example":"Resource missing","uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"Documentation URL for this error class (RFC 7807).","example":"https://docs.spotzee.com/main-api/errors#resource_missing","uniqueKey":"type","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Server-generated correlation ID. Echoed in the X-Request-ID response header.","example":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","uniqueKey":"request_id","typeLabel":"string"},"param":{"type":"string","description":"Name of the offending parameter, when a single field is at fault.","example":"id","uniqueKey":"param","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"Dotted path to the offending request field.","example":"email","isRequired":true,"uniqueKey":"errors.items.[INDEX].param","typeLabel":"string"},"code":{"type":"string","description":"Per-field error code.","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"example":"parameter_invalid_format","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, English (en-AU) explanation of this field error.","example":"Must be a valid email address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["param","code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Field-level errors when multiple parameters fail validation.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","code","message","error"],"description":"Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as `application/problem+json`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"resource_missing","message":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","error":"\u003cstring>","title":"Resource missing","type":"https://docs.spotzee.com/main-api/errors#resource_missing","request_id":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","param":"id","errors":[{"param":"email","code":"parameter_invalid_format","message":"Must be a valid email address."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"a9f6a74c-c54b-48f8-b8d6-57323b3ba01c":{"description":"Authenticated, but the credential lacks scope or role for this resource.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Constant marker indicating this payload is an error response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"description":"Stable, machine-readable error code. Safe to switch on; never localised.","example":"resource_missing","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, en-AU explanation. May include identifiers.","example":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Legacy human-readable mirror of `message`. Retained while in-product clients migrate; new integrations should read `message`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"title":{"type":"string","description":"Short, human-readable summary suitable for a heading. en-AU.","example":"Resource missing","uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"Documentation URL for this error class (RFC 7807).","example":"https://docs.spotzee.com/main-api/errors#resource_missing","uniqueKey":"type","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Server-generated correlation ID. Echoed in the X-Request-ID response header.","example":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","uniqueKey":"request_id","typeLabel":"string"},"param":{"type":"string","description":"Name of the offending parameter, when a single field is at fault.","example":"id","uniqueKey":"param","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"Dotted path to the offending request field.","example":"email","isRequired":true,"uniqueKey":"errors.items.[INDEX].param","typeLabel":"string"},"code":{"type":"string","description":"Per-field error code.","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"example":"parameter_invalid_format","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, English (en-AU) explanation of this field error.","example":"Must be a valid email address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["param","code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Field-level errors when multiple parameters fail validation.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","code","message","error"],"description":"Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as `application/problem+json`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"resource_missing","message":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","error":"\u003cstring>","title":"Resource missing","type":"https://docs.spotzee.com/main-api/errors#resource_missing","request_id":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","param":"id","errors":[{"param":"email","code":"parameter_invalid_format","message":"Must be a valid email address."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"f8b98d9a-fb47-4ccf-a923-50e6078debe9":{"description":"The referenced resource does not exist or is not visible to this key.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Constant marker indicating this payload is an error response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"description":"Stable, machine-readable error code. Safe to switch on; never localised.","example":"resource_missing","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, en-AU explanation. May include identifiers.","example":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Legacy human-readable mirror of `message`. Retained while in-product clients migrate; new integrations should read `message`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"title":{"type":"string","description":"Short, human-readable summary suitable for a heading. en-AU.","example":"Resource missing","uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"Documentation URL for this error class (RFC 7807).","example":"https://docs.spotzee.com/main-api/errors#resource_missing","uniqueKey":"type","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Server-generated correlation ID. Echoed in the X-Request-ID response header.","example":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","uniqueKey":"request_id","typeLabel":"string"},"param":{"type":"string","description":"Name of the offending parameter, when a single field is at fault.","example":"id","uniqueKey":"param","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"Dotted path to the offending request field.","example":"email","isRequired":true,"uniqueKey":"errors.items.[INDEX].param","typeLabel":"string"},"code":{"type":"string","description":"Per-field error code.","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"example":"parameter_invalid_format","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, English (en-AU) explanation of this field error.","example":"Must be a valid email address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["param","code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Field-level errors when multiple parameters fail validation.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","code","message","error"],"description":"Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as `application/problem+json`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"resource_missing","message":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","error":"\u003cstring>","title":"Resource missing","type":"https://docs.spotzee.com/main-api/errors#resource_missing","request_id":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","param":"id","errors":[{"param":"email","code":"parameter_invalid_format","message":"Must be a valid email address."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"72702aef-8f7d-4038-afd8-9d614ad3ae56":{"description":"Conflict — duplicate resource or idempotency-key body mismatch.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Constant marker indicating this payload is an error response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"description":"Stable, machine-readable error code. Safe to switch on; never localised.","example":"resource_missing","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, en-AU explanation. May include identifiers.","example":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Legacy human-readable mirror of `message`. Retained while in-product clients migrate; new integrations should read `message`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"title":{"type":"string","description":"Short, human-readable summary suitable for a heading. en-AU.","example":"Resource missing","uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"Documentation URL for this error class (RFC 7807).","example":"https://docs.spotzee.com/main-api/errors#resource_missing","uniqueKey":"type","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Server-generated correlation ID. Echoed in the X-Request-ID response header.","example":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","uniqueKey":"request_id","typeLabel":"string"},"param":{"type":"string","description":"Name of the offending parameter, when a single field is at fault.","example":"id","uniqueKey":"param","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"Dotted path to the offending request field.","example":"email","isRequired":true,"uniqueKey":"errors.items.[INDEX].param","typeLabel":"string"},"code":{"type":"string","description":"Per-field error code.","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"example":"parameter_invalid_format","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, English (en-AU) explanation of this field error.","example":"Must be a valid email address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["param","code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Field-level errors when multiple parameters fail validation.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","code","message","error"],"description":"Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as `application/problem+json`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"resource_missing","message":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","error":"\u003cstring>","title":"Resource missing","type":"https://docs.spotzee.com/main-api/errors#resource_missing","request_id":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","param":"id","errors":[{"param":"email","code":"parameter_invalid_format","message":"Must be a valid email address."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"907160ac-1ae4-4a9c-b76b-b31489cfa000":{"description":"Request was syntactically valid but semantically rejected (failed validation).","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Constant marker indicating this payload is an error response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"description":"Stable, machine-readable error code. Safe to switch on; never localised.","example":"resource_missing","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, en-AU explanation. May include identifiers.","example":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Legacy human-readable mirror of `message`. Retained while in-product clients migrate; new integrations should read `message`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"title":{"type":"string","description":"Short, human-readable summary suitable for a heading. en-AU.","example":"Resource missing","uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"Documentation URL for this error class (RFC 7807).","example":"https://docs.spotzee.com/main-api/errors#resource_missing","uniqueKey":"type","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Server-generated correlation ID. Echoed in the X-Request-ID response header.","example":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","uniqueKey":"request_id","typeLabel":"string"},"param":{"type":"string","description":"Name of the offending parameter, when a single field is at fault.","example":"id","uniqueKey":"param","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"Dotted path to the offending request field.","example":"email","isRequired":true,"uniqueKey":"errors.items.[INDEX].param","typeLabel":"string"},"code":{"type":"string","description":"Per-field error code.","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"example":"parameter_invalid_format","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, English (en-AU) explanation of this field error.","example":"Must be a valid email address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["param","code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Field-level errors when multiple parameters fail validation.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","code","message","error"],"description":"Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as `application/problem+json`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"resource_missing","message":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","error":"\u003cstring>","title":"Resource missing","type":"https://docs.spotzee.com/main-api/errors#resource_missing","request_id":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","param":"id","errors":[{"param":"email","code":"parameter_invalid_format","message":"Must be a valid email address."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"4a25455c-19d7-474d-a217-e35802a16c8b":{"description":"Rate-limit bucket exhausted. Honour `Retry-After`.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Constant marker indicating this payload is an error response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"description":"Stable, machine-readable error code. Safe to switch on; never localised.","example":"resource_missing","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, en-AU explanation. May include identifiers.","example":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Legacy human-readable mirror of `message`. Retained while in-product clients migrate; new integrations should read `message`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"title":{"type":"string","description":"Short, human-readable summary suitable for a heading. en-AU.","example":"Resource missing","uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"Documentation URL for this error class (RFC 7807).","example":"https://docs.spotzee.com/main-api/errors#resource_missing","uniqueKey":"type","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Server-generated correlation ID. Echoed in the X-Request-ID response header.","example":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","uniqueKey":"request_id","typeLabel":"string"},"param":{"type":"string","description":"Name of the offending parameter, when a single field is at fault.","example":"id","uniqueKey":"param","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"Dotted path to the offending request field.","example":"email","isRequired":true,"uniqueKey":"errors.items.[INDEX].param","typeLabel":"string"},"code":{"type":"string","description":"Per-field error code.","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"example":"parameter_invalid_format","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, English (en-AU) explanation of this field error.","example":"Must be a valid email address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["param","code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Field-level errors when multiple parameters fail validation.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","code","message","error"],"description":"Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as `application/problem+json`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"resource_missing","message":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","error":"\u003cstring>","title":"Resource missing","type":"https://docs.spotzee.com/main-api/errors#resource_missing","request_id":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","param":"id","errors":[{"param":"email","code":"parameter_invalid_format","message":"Must be a valid email address."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e3a1e6ab-d8b6-45a6-a4af-5e41ee86ec62":{"description":"Unhandled server error. `request_id` should be reported to support.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Constant marker indicating this payload is an error response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"description":"Stable, machine-readable error code. Safe to switch on; never localised.","example":"resource_missing","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, en-AU explanation. May include identifiers.","example":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Legacy human-readable mirror of `message`. Retained while in-product clients migrate; new integrations should read `message`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"title":{"type":"string","description":"Short, human-readable summary suitable for a heading. en-AU.","example":"Resource missing","uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"Documentation URL for this error class (RFC 7807).","example":"https://docs.spotzee.com/main-api/errors#resource_missing","uniqueKey":"type","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Server-generated correlation ID. Echoed in the X-Request-ID response header.","example":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","uniqueKey":"request_id","typeLabel":"string"},"param":{"type":"string","description":"Name of the offending parameter, when a single field is at fault.","example":"id","uniqueKey":"param","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"Dotted path to the offending request field.","example":"email","isRequired":true,"uniqueKey":"errors.items.[INDEX].param","typeLabel":"string"},"code":{"type":"string","description":"Per-field error code.","enum":["resource_missing","resource_already_exists","state_conflict","archived_user_conflict","user_capacity_exhausted","parameter_missing","parameter_invalid_empty","parameter_invalid_format","parameter_unknown","validation_failed","authentication_required","permission_denied","idempotency_key_mismatch","idempotency_key_invalid","idempotency_in_progress","rate_limited","version_unsupported","version_required","webhook_signature_invalid","quota_exceeded","service_unavailable","internal_error"],"example":"parameter_invalid_format","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, English (en-AU) explanation of this field error.","example":"Must be a valid email address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["param","code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Field-level errors when multiple parameters fail validation.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","code","message","error"],"description":"Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as `application/problem+json`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"resource_missing","message":"User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.","error":"\u003cstring>","title":"Resource missing","type":"https://docs.spotzee.com/main-api/errors#resource_missing","request_id":"req_01HXY7Z9K8M5J2N4P6Q8R0S1T2","param":"id","errors":[{"param":"email","code":"parameter_invalid_format","message":"Must be a valid email address."}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7ae32540-bf87-41c2-a2e8-c1d8d60b3353":{"projectApiKey":{"type":"http","scheme":"bearer","description":"Project-scoped secret API key (`sk_…`). Pass in the `Authorization: Bearer \u003ckey>` header. Grants access to the project the key was issued for.","scopes":[],"schemeName":"projectApiKey"}}},"servers":{"dabdc8e4-808c-4d81-a469-9a63571a0a73":{"url":"https://apix.spotzee.com/api/client"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Project-scoped secret API key (`sk_…`). Pass in the `Authorization: Bearer \u003ckey>` header. Grants access to the project the key was issued for.","scopes":[],"schemeName":"projectApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Project-scoped secret API key (`sk_…`). Pass in the `Authorization: Bearer \u003ckey>` header. Grants access to the project the key was issued for.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"projectApiKey","name":"Authorization"}],"title":"projectApiKey"}]},"originalFileLocation":"https://apix.spotzee.com/api/openapi.json"},"subdomain":"spotzee","siteName":"Spotzee","title":"List events - Spotzee","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T03:27:35.389Z","originalFileLocation":"api/events/list-events.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=\"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spotzee\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_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=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List events - Spotzee\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spotzee\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://spotzee.com/docs/api/events/list-events\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spotzee.mintlify.site/docs/_mintlify/api/og/v2?division=Events\u0026amp;title=List+events\u0026amp;description=Returns+matching+user+events+for+a+bounded+time+window.+Combine+user+identifiers%2C+event+names%2C+and+campaign+identifiers+to+narrow+the+result+set%3B+payloads+are+i\u0026amp;theme=7bbcfcf537bf0471a886c53a\u0026amp;signature=0d7da07741f483d6a9d8b4a5ac8393da3e89783ece6dc6f2118e49b0997eba28\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List events - Spotzee\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spotzee.mintlify.site/docs/_mintlify/api/og/v2?division=Events\u0026amp;title=List+events\u0026amp;description=Returns+matching+user+events+for+a+bounded+time+window.+Combine+user+identifiers%2C+event+names%2C+and+campaign+identifiers+to+narrow+the+result+set%3B+payloads+are+i\u0026amp;theme=7bbcfcf537bf0471a886c53a\u0026amp;signature=0d7da07741f483d6a9d8b4a5ac8393da3e89783ece6dc6f2118e49b0997eba28\">\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=\"/docs/mintlify-assets/_mintlify/favicons/spotzee/IWz69kANhWqwxRhY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spotzee\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6a75f1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://spotzee.com/docs/api/events/list-events\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/events/list-events.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://spotzee.com/#organization\",\"name\":\"Spotzee\",\"url\":\"https://spotzee.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spotzee/27QeIXddlVEQEUZJ/images/logo-light.svg?fit=max\u0026auto=format\u0026n=27QeIXddlVEQEUZJ\u0026q=85\u0026s=8db9a62cf5f9d992c6d6246a633e0e82\"}},{\"@type\":\"WebSite\",\"@id\":\"https://spotzee.com/docs#website\",\"name\":\"Spotzee\",\"url\":\"https://spotzee.com/docs\",\"publisher\":{\"@id\":\"https://spotzee.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://spotzee.com/docs/api/events/list-events#webpage\",\"url\":\"https://spotzee.com/docs/api/events/list-events\",\"name\":\"List events\",\"description\":\"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.\",\"dateModified\":\"2026-10-28T03:27:35.389Z\",\"isPartOf\":{\"@id\":\"https://spotzee.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://spotzee.com/docs/api/events/list-events#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://spotzee.com/docs/api/events/list-events#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Events\",\"item\":\"https://spotzee.com/docs/api/events/track-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List events\",\"item\":\"https://spotzee.com/docs/api/events/list-events\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://spotzee.com/docs/api/events/list-events#apireference\",\"headline\":\"List events\",\"name\":\"List events\",\"description\":\"Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.\",\"url\":\"https://spotzee.com/docs/api/events/list-events\",\"mainEntityOfPage\":{\"@id\":\"https://spotzee.com/docs/api/events/list-events#webpage\"},\"dateModified\":\"2026-10-28T03:27:35.389Z\",\"publisher\":{\"@id\":\"https://spotzee.com/#organization\"},\"isPartOf\":{\"@id\":\"https://spotzee.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spotzee\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Spotzee\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api/events/list-events.md","siteName":"Spotzee","nav":{"global":{"anchors":[{"anchor":"App","icon":"gauge","href":"https://app.spotzee.com"},{"anchor":"Website","icon":"globe","href":"https://spotzee.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Main API","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"Main API","href":"/main-api/introduction"},{"title":"Errors","href":"/main-api/errors"}]},{"group":"Projects","icon":"folder","pages":[{"title":"List projects in the organisation","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /projects","href":"/api/projects/list-projects-in-the-organisation"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /projects","href":"/api/projects/create-a-project"},{"title":"Get the current project","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /me","href":"/api/projects/get-the-current-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /projects/{projectId}","href":"/api/projects/update-a-project"},{"title":"Submit project onboarding metadata","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /projects/{projectId}/onboarding-metadata","href":"/api/projects/submit-project-onboarding-metadata"}]},{"group":"Users","icon":"users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /users","href":"/api/users/list-users"},{"title":"Upsert users","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /users","href":"/api/users/upsert-users"},{"title":"Delete users in bulk","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /users","href":"/api/users/delete-users-in-bulk"},{"title":"Bulk upsert users (synchronous)","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /users/batch","href":"/api/users/bulk-upsert-users-synchronous"},{"title":"Get the current user","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /users/me","href":"/api/users/get-the-current-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /users/{userId}","href":"/api/users/get-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /users/{userId}","href":"/api/users/delete-a-user"},{"title":"Mint a user session token","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /users/{userId}/sessions","href":"/api/users/mint-a-user-session-token"}]},{"group":"CRM","icon":"address-book","pages":[{"title":"List CRM properties","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/properties","href":"/api/crm/list-crm-properties"},{"title":"List CRM contacts","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/contacts","href":"/api/crm/list-crm-contacts"},{"title":"Get a CRM contact","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/contacts/{contactId}","href":"/api/crm/get-a-crm-contact"},{"title":"Update CRM contact properties","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /crm/contacts/{contactId}/properties","href":"/api/crm/update-crm-contact-properties"},{"title":"Move a CRM contact stage","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /crm/contacts/{contactId}/stage","href":"/api/crm/move-a-crm-contact-stage"},{"title":"List CRM companies","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/companies","href":"/api/crm/list-crm-companies"},{"title":"Create a CRM company","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /crm/companies","href":"/api/crm/create-a-crm-company"},{"title":"Get a CRM company","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/companies/{companyId}","href":"/api/crm/get-a-crm-company"},{"title":"Update a CRM company","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /crm/companies/{companyId}","href":"/api/crm/update-a-crm-company"},{"title":"List CRM company contacts","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/companies/{companyId}/contacts","href":"/api/crm/list-crm-company-contacts"},{"title":"List CRM company activities","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/companies/{companyId}/activities","href":"/api/crm/list-crm-company-activities"},{"title":"List CRM activities","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/activities","href":"/api/crm/list-crm-activities"},{"title":"Create a CRM activity","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /crm/activities","href":"/api/crm/create-a-crm-activity"},{"title":"List CRM pipeline stages","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/pipeline/stages","href":"/api/crm/list-crm-pipeline-stages"},{"title":"List CRM saved views","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/views","href":"/api/crm/list-crm-saved-views"}]},{"group":"Source Sync","icon":"arrows-rotate","pages":[{"title":"Upsert a source identity","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /source-systems/identities","href":"/api/source-sync/upsert-a-source-identity"},{"title":"Delete a source identity","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /source-systems/identities/{source}/{sourcePersonId}","href":"/api/source-sync/delete-a-source-identity"},{"title":"Upsert a source company","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /source-systems/companies","href":"/api/source-sync/upsert-a-source-company"},{"title":"Get a source company","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /source-systems/companies/{source}/{sourceCompanyId}","href":"/api/source-sync/get-a-source-company"},{"title":"Delete a source company","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /source-systems/companies/{source}/{sourceCompanyId}","href":"/api/source-sync/delete-a-source-company"},{"title":"Upsert source CRM property manifest","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /source-systems/property-manifests","href":"/api/source-sync/upsert-source-crm-property-manifest"},{"title":"Upsert a source membership","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /source-systems/memberships","href":"/api/source-sync/upsert-a-source-membership"}]},{"group":"Events","icon":"bolt","pages":[{"title":"Track events","description":"Records one or more behavioural events against a user. Events drive segmentation and journey triggers. Up to 100 events per request — supplying both `anonymous_id` and `external_id` on an event links the two identifiers. Optionally pass a `user` block to update the user’s profile in the same call.\n\nIdempotent — pass an `Idempotency-Key` header to make safely retryable. On a replay the original response is returned with `Idempotent-Replayed: true`. See the API conventions guide for the full state machine, TTL, and mismatch behaviour.","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /events","href":"/api/events/track-events"},{"title":"List events","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /events","href":"/api/events/list-events"},{"title":"Aggregate events","description":"Counts matching events for a bounded time window. Group by event, campaign, user, day, or any combination to answer occurrence and audience questions.","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /events/aggregations","href":"/api/events/aggregate-events"}]},{"group":"Lists","icon":"list","pages":[{"title":"List lists","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /lists","href":"/api/lists/list-lists"},{"title":"Create a list","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /lists","href":"/api/lists/create-a-list"},{"title":"Get a list","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /lists/{listId}","href":"/api/lists/get-a-list"},{"title":"Update a list","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /lists/{listId}","href":"/api/lists/update-a-list"},{"title":"Delete a list","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /lists/{listId}","href":"/api/lists/delete-a-list"}]},{"group":"Subscriptions","icon":"bell","pages":[{"title":"Bulk toggle the current user’s subscription states","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /subscriptions/me","href":"/api/subscriptions/bulk-toggle-the-current-user’s-subscription-states"},{"title":"List subscription types","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /subscriptions","href":"/api/subscriptions/list-subscription-types"},{"title":"Create a subscription type","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /subscriptions","href":"/api/subscriptions/create-a-subscription-type"},{"title":"Get a subscription type","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /subscriptions/{subscriptionId}","href":"/api/subscriptions/get-a-subscription-type"},{"title":"Update a subscription type","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /subscriptions/{subscriptionId}","href":"/api/subscriptions/update-a-subscription-type"},{"title":"Bulk toggle subscription states across many users","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /subscriptions/batch","href":"/api/subscriptions/bulk-toggle-subscription-states-across-many-users"},{"title":"List a user’s subscription states","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /users/{userId}/subscriptions","href":"/api/subscriptions/list-a-user’s-subscription-states"},{"title":"Bulk toggle a user’s subscription states","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /users/{userId}/subscriptions","href":"/api/subscriptions/bulk-toggle-a-user’s-subscription-states"}]},{"group":"Templates","icon":"file-lines","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /templates","href":"/api/templates/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /templates","href":"/api/templates/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /templates/{templateId}","href":"/api/templates/get-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /templates/{templateId}","href":"/api/templates/update-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /templates/{templateId}","href":"/api/templates/delete-a-template"},{"title":"Render a template preview","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /templates/{templateId}/preview","href":"/api/templates/render-a-template-preview"},{"title":"Send a proof of a template","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /templates/{templateId}/proof","href":"/api/templates/send-a-proof-of-a-template"}]},{"group":"Campaigns","icon":"paper-plane","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns","href":"/api/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /campaigns","href":"/api/campaigns/create-a-campaign"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns/{campaignId}","href":"/api/campaigns/get-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /campaigns/{campaignId}","href":"/api/campaigns/update-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /campaigns/{campaignId}","href":"/api/campaigns/delete-a-campaign"},{"title":"List campaign messages","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns/{campaignId}/recipients","href":"/api/campaigns/list-campaign-messages"},{"title":"Duplicate a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /campaigns/{campaignId}/duplicate","href":"/api/campaigns/duplicate-a-campaign"},{"title":"Render a campaign preview","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns/{campaignId}/preview","href":"/api/campaigns/render-a-campaign-preview"},{"title":"Trigger a campaign send for one user","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /campaigns/{campaignId}/trigger","href":"/api/campaigns/trigger-a-campaign-send-for-one-user"}]},{"group":"Journeys","icon":"route","pages":[{"title":"List journeys","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /journeys","href":"/api/journeys/list-journeys"},{"title":"Create a journey","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /journeys","href":"/api/journeys/create-a-journey"},{"title":"Get a journey","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /journeys/{journeyId}","href":"/api/journeys/get-a-journey"},{"title":"Update a journey","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /journeys/{journeyId}","href":"/api/journeys/update-a-journey"},{"title":"Delete a journey","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /journeys/{journeyId}","href":"/api/journeys/delete-a-journey"},{"title":"Trigger a journey entrance for one user","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /journeys/{journeyId}/trigger","href":"/api/journeys/trigger-a-journey-entrance-for-one-user"}]},{"group":"Tags","icon":"tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /tags","href":"/api/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /tags","href":"/api/tags/create-a-tag"},{"title":"Get a tag","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /tags/{tagId}","href":"/api/tags/get-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /tags/{tagId}","href":"/api/tags/update-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /tags/{tagId}","href":"/api/tags/delete-a-tag"}]},{"group":"API keys","icon":"key","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /keys","href":"/api/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /keys","href":"/api/api-keys/create-an-api-key"},{"title":"Get an API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /keys/{keyId}","href":"/api/api-keys/get-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /keys/{keyId}","href":"/api/api-keys/update-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /keys/{keyId}","href":"/api/api-keys/revoke-an-api-key"}]},{"group":"Organisation","icon":"building","pages":[{"title":"Get the current organisation","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/me","href":"/api/organisation/get-the-current-organisation"},{"title":"List organisation API keys","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/api-keys","href":"/api/organisation/list-organisation-api-keys"},{"title":"Create an organisation API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/api-keys","href":"/api/organisation/create-an-organisation-api-key"},{"title":"Get an organisation API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/api-keys/{keyId}","href":"/api/organisation/get-an-organisation-api-key"},{"title":"Update an organisation API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /organizations/api-keys/{keyId}","href":"/api/organisation/update-an-organisation-api-key"},{"title":"Revoke an organisation API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /organizations/api-keys/{keyId}","href":"/api/organisation/revoke-an-organisation-api-key"}]},{"group":"Webhooks","icon":"link","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /webhooks","href":"/api/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /webhooks","href":"/api/webhooks/create-a-webhook-endpoint"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /webhooks/{endpointId}/rotate-secret","href":"/api/webhooks/rotate-a-webhook-signing-secret"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /webhooks/{endpointId}","href":"/api/webhooks/get-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /webhooks/{endpointId}","href":"/api/webhooks/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /webhooks/{endpointId}","href":"/api/webhooks/delete-a-webhook-endpoint"}]},{"group":"Billing recovery","icon":"credit-card","pages":[{"title":"Get organisation recovery status","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/recoveries/status","href":"/api/billing-recovery/get-organisation-recovery-status"},{"title":"List project user contributions","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/recoveries/projects","href":"/api/billing-recovery/list-project-user-contributions"},{"title":"Search active users for recovery","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/recoveries/users","href":"/api/billing-recovery/search-active-users-for-recovery"},{"title":"Preview an immutable recovery archive selection","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/recoveries/users/archives/preview","href":"/api/billing-recovery/preview-an-immutable-recovery-archive-selection"},{"title":"Submit a verified recovery archive job","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/recoveries/users/archives","href":"/api/billing-recovery/submit-a-verified-recovery-archive-job"},{"title":"Get recovery job progress","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/recoveries/jobs/{jobId}","href":"/api/billing-recovery/get-recovery-job-progress"},{"title":"Retry an authoritative recovery recount","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/recoveries/jobs/{jobId}/recounts","href":"/api/billing-recovery/retry-an-authoritative-recovery-recount"},{"title":"Restore archived users when capacity permits","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/recoveries/users/restorations","href":"/api/billing-recovery/restore-archived-users-when-capacity-permits"}]},{"group":"Form definitions","icon":"clipboard-list","pages":[{"title":"List form definitions","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /form-definitions","href":"/api/form-definitions/list-form-definitions"},{"title":"Create a form definition","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /form-definitions","href":"/api/form-definitions/create-a-form-definition"},{"title":"Get a form definition","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /form-definitions/{formDefinitionId}","href":"/api/form-definitions/get-a-form-definition"},{"title":"Update a form definition","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /form-definitions/{formDefinitionId}","href":"/api/form-definitions/update-a-form-definition"},{"title":"Delete a form definition","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /form-definitions/{formDefinitionId}","href":"/api/form-definitions/delete-a-form-definition"}]},{"group":"Form submissions","icon":"file-circle-check","pages":[{"title":"Submit a public form","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /forms/{publicToken}/submissions","href":"/api/form-submissions/submit-a-public-form"}]}]},{"tab":"Extended API","pages":[{"title":"Extended API","href":"/extended-api/introduction"}]}]},"basePath":"","title":"List events - Spotzee","buildId":"dpl_6PxPD4Fj1JDU9BJxEHvfdUmxKThw","deploymentId":"dpl_6PxPD4Fj1JDU9BJxEHvfdUmxKThw","dynamics":["c2aa737661","b0f84f53ff","2b790eda92","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CASS2Vpq.js","utils-4k9fyWRu.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-UU-UueZb.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BgJ0LOYq.js","snippetPresets-CMgzlMR-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DvEUoD2H.js","ApiExamples-BzEJegkK.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CZuQIZdk.js","shallow-Bw5arfMA.js","getApiPlaygroundDisplay-Ds834aVN.js","CodeSnippet-CKzmjw9L.js","CodeSnippets-BRpgomdp.js","getPastedJson-B0N-Tn76.js","icon-DASMs9nC.js","MethodPill-BA6DBLqx.js","DuplicateIcon-BMT5qfbJ.js","createIcon-CNfwVWPx.js","DynamicMarkdown-JYyBNlrJ.js","SectionHeading-BbZnmz8a.js","axios-vUo_bRtp.js","Markdown-LUU0YLpA.js","clsx-Di4ek5Ae.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-VEVWQCR4.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CPszyu99.js"]}