Hydrated delivery provider referenced by provider_id. Returned in the redacted public shape — see Provider schema. Credentials (data, auth, API keys, tokens) are NEVER included.
Bounce counts by stable cause identifier. unknown is displayed as Unclassified when evidence is missing, unmatched, or ambiguous. Counts reconcile to bounced.
{
"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}],"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/campaigns/list-campaigns","slug":"/api/campaigns/list-campaigns","pageMetadata":{"title":"List campaigns","description":"Returns a paginated list of campaigns in the project, ordered by `created_at` descending by default.","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns","href":"/api/campaigns/list-campaigns","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns a paginated list of campaigns in the project, ordered by \", _jsx(_components.code, {\n children: \"created_at\"\n }), \" descending 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 campaigns","description":"Returns a paginated list of campaigns in the project, ordered by `created_at` descending by default.","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns","href":"/api/campaigns/list-campaigns","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listCampaigns","summary":"List campaigns","description":"Returns a paginated list of campaigns in the project, ordered by `created_at` descending by default.","tags":["Campaigns"],"security":["53073115-f317-4132-a882-cf889572e378"],"servers":["351f4d55-9819-4d8f-845c-fdd91b4a89db"],"parameters":["5ae84875-6bfb-405c-87b2-90dcf4155861","852c38b8-86f5-47f0-85ab-6ae5fc25aa38","9f3e8011-0986-4715-a841-042fb633ccd2","7e70fe91-ca78-490f-afe6-227b41127889","6d6c39ce-96b2-475a-8899-1831c81f3873","ff534e3a-2674-49e0-b217-f026ec06fc37"],"responses":{"200":"26ecc346-13bc-46e9-abae-7e60d3e0d7f5","400":"d9b5699c-0a70-402f-a495-ade98814c8b6","401":"b11efc55-fe3b-45d4-bba9-f191eaefa96b","403":"faef1331-71df-4b88-a250-bd6cda7c5ba1","404":"9036b10b-8ef9-4502-a2c3-fc9e4bb1bd2d","409":"6d06665c-c106-48cf-9cc3-a102923e031a","422":"a9fe2cd9-ae13-4267-9f83-bea76452d5dd","429":"754f951a-bc4e-46c4-a927-5d48978981d0","500":"4ca3e3e3-ec3e-4c75-8a1e-265fe38bb1f5"},"method":"get","type":"path","path":"/campaigns","baseUrlOptions":["https://apix.spotzee.com/api/client"],"title":"List campaigns","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5ae84875-6bfb-405c-87b2-90dcf4155861":{"schema":{"type":"string","description":"Opaque cursor returned by a previous page response. Omit on the first request.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Opaque cursor returned by a previous page response. Omit on the first request.","name":"cursor","in":"query"},"852c38b8-86f5-47f0-85ab-6ae5fc25aa38":{"schema":{"type":"string","enum":["next","prev"],"description":"Direction to walk relative to `cursor`. Defaults to `next` when omitted.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Direction to walk relative to `cursor`. Defaults to `next` when omitted.","name":"page","in":"query"},"9f3e8011-0986-4715-a841-042fb633ccd2":{"schema":{"oneOf":[{"type":"integer","minimum":-1,"maximum":100,"default":25,"description":"Maximum results per page. Use `-1` to request all (rate-limited; large pages may be rejected).","example":25,"uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","minimum":-1,"maximum":100,"default":25,"description":"Maximum results per page. Use `-1` to request all (rate-limited; large pages may be rejected).","example":25,"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"},"required":false,"description":"Maximum results per page. Use `-1` to request all (rate-limited; large pages may be rejected).","name":"limit","in":"query"},"7e70fe91-ca78-490f-afe6-227b41127889":{"schema":{"type":"string","description":"Field to sort by. Defaults vary per resource.","example":"created_at","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Field to sort by. Defaults vary per resource.","name":"sort","in":"query"},"6d6c39ce-96b2-475a-8899-1831c81f3873":{"schema":{"type":"string","enum":["asc","desc"],"description":"Sort direction. Defaults vary per resource.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Sort direction. Defaults vary per resource.","name":"direction","in":"query"},"ff534e3a-2674-49e0-b217-f026ec06fc37":{"schema":{"type":"string","description":"Free-text search across the resource’s indexed fields.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Free-text search across the resource’s indexed fields.","name":"q","in":"query"}},"responses":{"26ecc346-13bc-46e9-abae-7e60d3e0d7f5":{"description":"A page of campaigns.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Numeric campaign identifier.","example":24,"isRequired":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"integer"},"project_id":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].project_id","typeLabel":"integer"},"type":{"type":"string","enum":["blast","trigger"],"description":"`blast` campaigns send to every user in the target lists. `trigger` campaigns fire per-user when an event matches.","isRequired":true,"uniqueKey":"results.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].name","typeLabel":"string"},"channel":{"type":"string","enum":["email","text","push","webhook","in_app"],"description":"Delivery channel the campaign sends through.","isRequired":true,"uniqueKey":"results.items.[INDEX].channel","typeLabel":"enum\u003cstring>"},"subscription_id":{"type":"integer","description":"Subscription type a user must be opted in to in order to receive this campaign.","isRequired":true,"uniqueKey":"results.items.[INDEX].subscription_id","typeLabel":"integer"},"provider_id":{"type":"integer","description":"Delivery provider used to send the campaign.","isRequired":true,"uniqueKey":"results.items.[INDEX].provider_id","typeLabel":"integer"},"state":{"type":"string","enum":["draft","scheduled","loading","running","finished","aborting","aborted"],"description":"Campaign lifecycle state. Set `state: \"scheduled\"` (with `send_at`) to send a blast; set `state: \"aborted\"` to cancel.","isRequired":true,"uniqueKey":"results.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"created_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].created_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"results.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].updated_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"results.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].updated_at","typeLabel":"string | null"},"list_ids":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"results.items.[INDEX].list_ids.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"IDs of the lists targeted by the campaign.","uniqueKey":"results.items.[INDEX].list_ids.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"IDs of the lists targeted by the campaign.","uniqueKey":"results.items.[INDEX].list_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].list_ids","typeLabel":"integer[] | null"},"exclusion_list_ids":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"results.items.[INDEX].exclusion_list_ids.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"IDs of lists whose members should be excluded from the campaign.","uniqueKey":"results.items.[INDEX].exclusion_list_ids.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"IDs of lists whose members should be excluded from the campaign.","uniqueKey":"results.items.[INDEX].exclusion_list_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].exclusion_list_ids","typeLabel":"integer[] | null"},"subscription":{"type":"object","properties":{"id":{"type":"integer","description":"Numeric subscription-type identifier.","example":7,"isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.id","typeLabel":"integer"},"project_id":{"type":"integer","description":"Identifier of the owning project.","example":42,"isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.project_id","typeLabel":"integer"},"name":{"type":"string","description":"Human-readable subscription-type name shown on preference centres.","example":"Weekly newsletter","isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.name","typeLabel":"string"},"channel":{"type":"string","enum":["email","text","push","webhook","in_app"],"description":"Delivery channel a subscription type covers.","example":"email","isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.channel","typeLabel":"enum\u003cstring>"},"is_public":{"type":"boolean","description":"Whether this subscription type is shown on customer-facing preference centres.","isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.is_public","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"string","description":"Time the subscription type was created. ISO 8601.","isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time the subscription type was created. ISO 8601.","isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","description":"Time the subscription type was last modified. ISO 8601.","isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.updated_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time the subscription type was last modified. ISO 8601.","isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].subscription.updated_at","typeLabel":"string | null"}},"required":["id","project_id","name","channel","is_public","created_at","updated_at"],"description":"Hydrated subscription type referenced by `subscription_id`.","uniqueKey":"results.items.[INDEX].subscription","typeLabel":"object"},"provider":{"type":"object","properties":{"id":{"type":"integer","description":"Numeric provider identifier.","example":19,"isRequired":true,"uniqueKey":"results.items.[INDEX].provider.id","typeLabel":"integer"},"project_id":{"type":"integer","description":"Identifier of the owning project.","example":42,"isRequired":true,"uniqueKey":"results.items.[INDEX].provider.project_id","typeLabel":"integer"},"type":{"type":"string","description":"Provider type within its group — the exact identifier of the underlying integration.","example":"smtp","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.type","typeLabel":"string"},"name":{"type":"string","description":"Human-readable provider name shown in dashboards.","example":"Primary transactional SMTP","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.name","typeLabel":"string"},"group":{"type":"string","enum":["email","text","push","webhook","analytics"],"description":"Channel family the provider belongs to.","example":"email","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.group","typeLabel":"enum\u003cstring>"},"is_default":{"type":"boolean","description":"Whether this provider is the default for its group within the project.","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.is_default","typeLabel":"boolean"},"rate_limit":{"type":"integer","minimum":0,"description":"Maximum sends per `rate_interval`. Zero means unlimited.","example":0,"isRequired":true,"uniqueKey":"results.items.[INDEX].provider.rate_limit","typeLabel":"integer"},"rate_interval":{"type":"string","enum":["second","minute","hour","day"],"description":"Window over which `rate_limit` is counted.","example":"second","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.rate_interval","typeLabel":"enum\u003cstring>"},"created_at":{"oneOf":[{"type":"string","description":"Time the provider was created. ISO 8601.","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time the provider was created. ISO 8601.","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].provider.created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","description":"Time the provider was last modified. ISO 8601.","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.updated_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time the provider was last modified. ISO 8601.","isRequired":true,"uniqueKey":"results.items.[INDEX].provider.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].provider.updated_at","typeLabel":"string | null"},"deleted_at":{"oneOf":[{"type":"string","description":"Time the provider was soft-deleted, if applicable.","uniqueKey":"results.items.[INDEX].provider.deleted_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time the provider was soft-deleted, if applicable.","uniqueKey":"results.items.[INDEX].provider.deleted_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].provider.deleted_at","typeLabel":"string | null"}},"required":["id","project_id","type","name","group","is_default","rate_limit","rate_interval","created_at","updated_at"],"description":"Hydrated delivery provider referenced by `provider_id`. Returned in the redacted public shape — see `Provider` schema. Credentials (`data`, `auth`, API keys, tokens) are NEVER included.","uniqueKey":"results.items.[INDEX].provider","typeLabel":"object"},"delivery":{"type":"object","properties":{"sent":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].delivery.sent","typeLabel":"integer"},"total":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].delivery.total","typeLabel":"integer"},"opens":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].delivery.opens","typeLabel":"integer"},"clicks":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].delivery.clicks","typeLabel":"integer"},"bounced":{"type":"integer","uniqueKey":"results.items.[INDEX].delivery.bounced","typeLabel":"integer"},"bounce_categories":{"type":"object","properties":{"invalid_recipient":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.invalid_recipient","typeLabel":"integer"},"mailbox_unavailable":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.mailbox_unavailable","typeLabel":"integer"},"mailbox_full":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.mailbox_full","typeLabel":"integer"},"authentication_failed":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.authentication_failed","typeLabel":"integer"},"policy_blocked":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.policy_blocked","typeLabel":"integer"},"spam_rejected":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.spam_rejected","typeLabel":"integer"},"reputation_blocked":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.reputation_blocked","typeLabel":"integer"},"rate_limited":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.rate_limited","typeLabel":"integer"},"content_rejected":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.content_rejected","typeLabel":"integer"},"dns_routing_error":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.dns_routing_error","typeLabel":"integer"},"transport_error":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.transport_error","typeLabel":"integer"},"unknown":{"type":"integer","minimum":0,"uniqueKey":"results.items.[INDEX].delivery.bounce_categories.unknown","typeLabel":"integer"}},"description":"Bounce counts by stable cause identifier. `unknown` is displayed as Unclassified when evidence is missing, unmatched, or ambiguous. Counts reconcile to `bounced`.","uniqueKey":"results.items.[INDEX].delivery.bounce_categories","typeLabel":"object"},"classification_coverage":{"type":"object","properties":{"classified":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"results.items.[INDEX].delivery.classification_coverage.classified","typeLabel":"integer"},"unclassified":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"results.items.[INDEX].delivery.classification_coverage.unclassified","typeLabel":"integer"},"total":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"results.items.[INDEX].delivery.classification_coverage.total","typeLabel":"integer"}},"required":["classified","unclassified","total"],"description":"Counts of classified and unclassified bounced messages.","uniqueKey":"results.items.[INDEX].delivery.classification_coverage","typeLabel":"object"},"calculated_at":{"type":"string","format":"date-time","uniqueKey":"results.items.[INDEX].delivery.calculated_at","typeLabel":"string\u003cdate-time>"}},"required":["sent","total","opens","clicks"],"description":"Aggregated delivery counters for the campaign.","uniqueKey":"results.items.[INDEX].delivery","typeLabel":"object"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"results.items.[INDEX].tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].tags","typeLabel":"string[] | null"},"send_in_user_timezone":{"oneOf":[{"type":"boolean","description":"When true, `send_at` is interpreted as a wall-clock time in each user’s local timezone.","uniqueKey":"results.items.[INDEX].send_in_user_timezone.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, `send_at` is interpreted as a wall-clock time in each user’s local timezone.","uniqueKey":"results.items.[INDEX].send_in_user_timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].send_in_user_timezone","typeLabel":"boolean | null"},"send_at":{"oneOf":[{"type":"string","description":"When the campaign should send. ISO 8601 string accepted on input.","uniqueKey":"results.items.[INDEX].send_at.oneOf.0","typeLabel":"string"},{"type":"string","description":"When the campaign should send. ISO 8601 string accepted on input.","uniqueKey":"results.items.[INDEX].send_at.oneOf.1","typeLabel":"string"},{"type":"null","description":"When the campaign should send. ISO 8601 string accepted on input.","uniqueKey":"results.items.[INDEX].send_at.oneOf.2","typeLabel":"null"},{"type":"null","description":"When the campaign should send. ISO 8601 string accepted on input.","uniqueKey":"results.items.[INDEX].send_at.oneOf.3","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].send_at","typeLabel":"string · string · null · null"},"custom_domain_id":{"oneOf":[{"type":"integer","description":"Optional override of the project’s default tracking and from-address domain.","uniqueKey":"results.items.[INDEX].custom_domain_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Optional override of the project’s default tracking and from-address domain.","uniqueKey":"results.items.[INDEX].custom_domain_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].custom_domain_id","typeLabel":"integer | null"},"created_by":{"oneOf":[{"type":"integer","description":"Admin who created the campaign. Null for system- or API-key-created campaigns.","uniqueKey":"results.items.[INDEX].created_by.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Admin who created the campaign. Null for system- or API-key-created campaigns.","uniqueKey":"results.items.[INDEX].created_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].created_by","typeLabel":"integer | null"},"created_by_admin":{"oneOf":[{"type":"object","properties":{"admin_id":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.admin_id","typeLabel":"integer"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","format":"email","uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0.email","typeLabel":"string\u003cemail> | null"}},"required":["admin_id"],"description":"Safe display details for `created_by`, or null when the creator is system/API-key-created or no longer belongs to the project.","uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"admin_id":{"type":"integer"},"first_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"last_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"email":{"oneOf":[{"type":"string","format":"email"},{"type":"null","format":"email"}]}},"required":["admin_id"],"description":"Safe display details for `created_by`, or null when the creator is system/API-key-created or no longer belongs to the project.","uniqueKey":"results.items.[INDEX].created_by_admin.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].created_by_admin","typeLabel":"object | null"},"description":{"oneOf":[{"type":"string","description":"Internal-only description for the audit trail. Never shown to recipients.","uniqueKey":"results.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal-only description for the audit trail. Never shown to recipients.","uniqueKey":"results.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].description","typeLabel":"string | null"}},"required":["id","project_id","type","name","channel","subscription_id","provider_id","state","created_at","updated_at"],"description":"A one-off (`blast`) or per-user (`trigger`) send across one channel.","uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"description":"Page of results, ordered per the request’s `sort` and `direction`.","isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"nextCursor":{"oneOf":[{"type":"string","description":"Opaque cursor for the next page. `null` when no further pages exist.","isRequired":true,"uniqueKey":"nextCursor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Opaque cursor for the next page. `null` when no further pages exist.","isRequired":true,"uniqueKey":"nextCursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nextCursor","typeLabel":"string | null"},"prevCursor":{"oneOf":[{"type":"string","description":"Opaque cursor for the previous page. `null` when on the first page.","isRequired":true,"uniqueKey":"prevCursor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Opaque cursor for the previous page. `null` when on the first page.","isRequired":true,"uniqueKey":"prevCursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"prevCursor","typeLabel":"string | null"},"limit":{"type":"integer","description":"Page size used to build this response.","isRequired":true,"uniqueKey":"limit","typeLabel":"integer"}},"required":["results","nextCursor","prevCursor","limit"],"description":"Paginated response of `CampaignList`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"results":[{"id":24,"project_id":123,"type":"blast","name":"\u003cstring>","channel":"email","subscription_id":123,"provider_id":123,"state":"draft","created_at":"\u003cstring>","updated_at":"\u003cstring>","list_ids":[123],"exclusion_list_ids":[123],"subscription":{"id":7,"project_id":42,"name":"Weekly newsletter","channel":"email","is_public":true,"created_at":"\u003cstring>","updated_at":"\u003cstring>"},"provider":{"id":19,"project_id":42,"type":"smtp","name":"Primary transactional SMTP","group":"email","is_default":true,"rate_limit":0,"rate_interval":"second","created_at":"\u003cstring>","updated_at":"\u003cstring>","deleted_at":"\u003cstring>"},"delivery":{"sent":123,"total":123,"opens":123,"clicks":123,"bounced":123,"bounce_categories":{"invalid_recipient":1,"mailbox_unavailable":1,"mailbox_full":1,"authentication_failed":1,"policy_blocked":1,"spam_rejected":1,"reputation_blocked":1,"rate_limited":1,"content_rejected":1,"dns_routing_error":1,"transport_error":1,"unknown":1},"classification_coverage":{"classified":1,"unclassified":1,"total":1},"calculated_at":"2023-11-07T05:31:56Z"},"tags":["\u003cstring>"],"send_in_user_timezone":true,"send_at":"\u003cstring>","custom_domain_id":123,"created_by":123,"created_by_admin":{"admin_id":123,"first_name":"\u003cstring>","last_name":"\u003cstring>","email":"jsmith@example.com"},"description":"\u003cstring>"}],"nextCursor":"\u003cstring>","prevCursor":"\u003cstring>","limit":123}}},"exampleType":"generated"}},"exampleType":"generated"},"d9b5699c-0a70-402f-a495-ade98814c8b6":{"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"},"b11efc55-fe3b-45d4-bba9-f191eaefa96b":{"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"},"faef1331-71df-4b88-a250-bd6cda7c5ba1":{"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"},"9036b10b-8ef9-4502-a2c3-fc9e4bb1bd2d":{"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"},"6d06665c-c106-48cf-9cc3-a102923e031a":{"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"},"a9fe2cd9-ae13-4267-9f83-bea76452d5dd":{"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"},"754f951a-bc4e-46c4-a927-5d48978981d0":{"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"},"4ca3e3e3-ec3e-4c75-8a1e-265fe38bb1f5":{"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":{"53073115-f317-4132-a882-cf889572e378":{"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":{"351f4d55-9819-4d8f-845c-fdd91b4a89db":{"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 campaigns - Spotzee","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T03:27:35.607Z","originalFileLocation":"api/campaigns/list-campaigns.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 a paginated list of campaigns in the project, ordered by created_at descending 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 campaigns - Spotzee\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a paginated list of campaigns in the project, ordered by created_at descending 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/campaigns/list-campaigns\">\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=Campaigns\u0026amp;title=List+campaigns\u0026amp;description=Returns+a+paginated+list+of+campaigns+in+the+project%2C+ordered+by+%60created_at%60+descending+by+default.\u0026amp;theme=7bbcfcf537bf0471a886c53a\u0026amp;signature=0d9f3440e1e785b635c365c3c78cc43c308a89213ee6fea26f12bf1abc1b067e\">\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 campaigns - Spotzee\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a paginated list of campaigns in the project, ordered by created_at descending by default.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spotzee.mintlify.site/docs/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=List+campaigns\u0026amp;description=Returns+a+paginated+list+of+campaigns+in+the+project%2C+ordered+by+%60created_at%60+descending+by+default.\u0026amp;theme=7bbcfcf537bf0471a886c53a\u0026amp;signature=0d9f3440e1e785b635c365c3c78cc43c308a89213ee6fea26f12bf1abc1b067e\">\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/campaigns/list-campaigns\">\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/campaigns/list-campaigns.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/campaigns/list-campaigns#webpage\",\"url\":\"https://spotzee.com/docs/api/campaigns/list-campaigns\",\"name\":\"List campaigns\",\"description\":\"Returns a paginated list of campaigns in the project, ordered by created_at descending by default.\",\"dateModified\":\"2026-10-28T03:27:35.607Z\",\"isPartOf\":{\"@id\":\"https://spotzee.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://spotzee.com/docs/api/campaigns/list-campaigns#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://spotzee.com/docs/api/campaigns/list-campaigns#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Spotzee\",\"item\":\"https://spotzee.com/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List campaigns\",\"item\":\"https://spotzee.com/docs/api/campaigns/list-campaigns\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://spotzee.com/docs/api/campaigns/list-campaigns#apireference\",\"headline\":\"List campaigns\",\"name\":\"List campaigns\",\"description\":\"Returns a paginated list of campaigns in the project, ordered by created_at descending by default.\",\"url\":\"https://spotzee.com/docs/api/campaigns/list-campaigns\",\"mainEntityOfPage\":{\"@id\":\"https://spotzee.com/docs/api/campaigns/list-campaigns#webpage\"},\"dateModified\":\"2026-10-28T03:27:35.607Z\",\"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/campaigns/list-campaigns.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","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","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","description":"Renders the template with the supplied variables and sends a one-off proof to a single recipient. Useful for content review before launching a campaign.\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 /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","description":"Creates a new campaign. To schedule a blast send, follow up with `PATCH /:campaignId` setting `state: \"scheduled\"` and `send_at`.\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 /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 campaigns - 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"]}