{
"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":""},"chroma":{"liveDeploymentHistoryId":"6ae483863ba31227325df265","collectionId":"afaec307-8915-4793-8d23-5d2627bb08a0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae483863ba31227325df265"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aee8685d2328aff4fbdb2cd","clientVersion":"0.0.4076","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","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/crm/list-crm-companies","slug":"/api/crm/list-crm-companies","pageMetadata":{"title":"List CRM companies","description":"Returns CRM company projections with public CRM properties only.","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/companies","href":"/api/crm/list-crm-companies","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns CRM company projections with public CRM properties only.\"\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 CRM companies","description":"Returns CRM company projections with public CRM properties only.","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /crm/companies","href":"/api/crm/list-crm-companies","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listCrmCompanies","summary":"List CRM companies","description":"Returns CRM company projections with public CRM properties only.","tags":["CRM"],"security":["1955aa8a-8b74-42cb-a3f6-104a844d41ca"],"servers":["948f7c44-1891-4e0f-9bf9-966b47d5138a"],"parameters":["9ff4a172-0147-4ba0-b4bf-b5f1881c2eb9","85e04ffe-cb28-47c1-a16f-a087874f1a41","0d2b153a-28f0-490a-9820-bc1aaa1e1332","fa164420-d98c-4bea-8009-0d631d65e4ce","cc9a7ce2-00b7-46fb-8125-d12460c5eca1","8ff94314-bb60-460d-b9d0-3877f2a44b5b"],"responses":{"200":"4329820e-1ae7-4558-96fb-7b77144127e4","400":"df5819ae-1baf-49e6-8056-655db8b0830b","401":"cd4ea40c-b079-4bc9-8578-7dfed98101ae","403":"2f1d8a0f-84b7-4f84-945e-58c968c6680d","404":"352371b1-3e6a-4356-87c0-6fad203b3659","409":"40a33244-64b7-4020-a224-07301aa07fa9","422":"6eba8941-6d0e-44f2-b589-1b994840521f","429":"bddd0370-dd5f-42b1-8ef5-a8364846a471","500":"219afdd9-e0d4-4aca-9023-6e0d745f28cf"},"method":"get","type":"path","path":"/crm/companies","baseUrlOptions":["https://apix.spotzee.com/api/client"],"title":"List CRM companies","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9ff4a172-0147-4ba0-b4bf-b5f1881c2eb9":{"schema":{"type":"string","description":"Opaque cursor returned by a previous page response.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Opaque cursor returned by a previous page response.","name":"cursor","in":"query"},"85e04ffe-cb28-47c1-a16f-a087874f1a41":{"schema":{"type":"string","enum":["next","prev"],"description":"Direction to walk relative to `cursor`. Defaults to `next`.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Direction to walk relative to `cursor`. Defaults to `next`.","name":"page","in":"query"},"0d2b153a-28f0-490a-9820-bc1aaa1e1332":{"schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Maximum results per page. Maximum is 100.","example":25,"isRequired":false,"uniqueKey":"","typeLabel":"integer"},"required":false,"description":"Maximum results per page. Maximum is 100.","name":"limit","in":"query"},"fa164420-d98c-4bea-8009-0d631d65e4ce":{"schema":{"type":"string","description":"Field to sort by. Defaults vary by resource.","example":"created_at","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Field to sort by. Defaults vary by resource.","name":"sort","in":"query"},"cc9a7ce2-00b7-46fb-8125-d12460c5eca1":{"schema":{"type":"string","enum":["asc","desc"],"description":"Sort direction. Defaults vary by resource.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Sort direction. Defaults vary by resource.","name":"direction","in":"query"},"8ff94314-bb60-460d-b9d0-3877f2a44b5b":{"schema":{"type":"string","description":"Free-text search across indexed CRM fields.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Free-text search across indexed CRM fields.","name":"q","in":"query"}},"responses":{"4329820e-1ae7-4558-96fb-7b77144127e4":{"description":"A page of CRM companies.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Numeric CRM company identifier.","example":55,"isRequired":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","description":"Company name.","example":"Acme Group","isRequired":true,"uniqueKey":"results.items.[INDEX].name","typeLabel":"string"},"properties":{"type":"object","additionalProperties":true,"description":"Public CRM company property values keyed by property key.","example":{"industry":"Finance"},"isRequired":true,"uniqueKey":"results.items.[INDEX].properties","typeLabel":"object"},"domain":{"oneOf":[{"type":"string","description":"Company domain, when known.","example":"acme.example","uniqueKey":"results.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"Company domain, when known.","example":"acme.example","uniqueKey":"results.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].domain","typeLabel":"string | null"},"contacts_count":{"type":"integer","description":"Number of linked contacts, when included.","example":12,"uniqueKey":"results.items.[INDEX].contacts_count","typeLabel":"integer"},"created_at":{"oneOf":[{"type":"string","description":"Time the company was created. ISO 8601.","uniqueKey":"results.items.[INDEX].created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time the company was created. ISO 8601.","uniqueKey":"results.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","description":"Time the company was last modified. ISO 8601.","uniqueKey":"results.items.[INDEX].updated_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time the company was last modified. ISO 8601.","uniqueKey":"results.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].updated_at","typeLabel":"string | null"}},"required":["id","name","properties"],"description":"Public CRM company projection.","uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"nextCursor":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"nextCursor.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"nextCursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nextCursor","typeLabel":"string | null"},"prevCursor":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"prevCursor.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"prevCursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"prevCursor","typeLabel":"string | null"},"limit":{"type":"integer","isRequired":true,"uniqueKey":"limit","typeLabel":"integer"}},"required":["results","nextCursor","prevCursor","limit"],"description":"Paginated CRM companies response.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"results":[{"id":55,"name":"Acme Group","properties":{"industry":"Finance"},"domain":"acme.example","contacts_count":12,"created_at":"\u003cstring>","updated_at":"\u003cstring>"}],"nextCursor":"\u003cstring>","prevCursor":"\u003cstring>","limit":123}}},"exampleType":"generated"}},"exampleType":"generated"},"df5819ae-1baf-49e6-8056-655db8b0830b":{"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"},"cd4ea40c-b079-4bc9-8578-7dfed98101ae":{"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"},"2f1d8a0f-84b7-4f84-945e-58c968c6680d":{"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"},"352371b1-3e6a-4356-87c0-6fad203b3659":{"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"},"40a33244-64b7-4020-a224-07301aa07fa9":{"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"},"6eba8941-6d0e-44f2-b589-1b994840521f":{"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"},"bddd0370-dd5f-42b1-8ef5-a8364846a471":{"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"},"219afdd9-e0d4-4aca-9023-6e0d745f28cf":{"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":{"1955aa8a-8b74-42cb-a3f6-104a844d41ca":{"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":{"948f7c44-1891-4e0f-9bf9-966b47d5138a":{"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 CRM companies - Spotzee","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T03:27:35.221Z","originalFileLocation":"api/crm/list-crm-companies.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 CRM company projections with public CRM properties only.\">\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 CRM companies - Spotzee\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns CRM company projections with public CRM properties only.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spotzee\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://spotzee.com/docs/api/crm/list-crm-companies\">\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=CRM\u0026amp;title=List+CRM+companies\u0026amp;description=Returns+CRM+company+projections+with+public+CRM+properties+only.\u0026amp;theme=6e26f6810543b3fc9ebb821a\u0026amp;signature=8924847cb8c07f15278d64e9bf0d8dd4ba747c920c26ff769ea02c2438c31efd\">\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 CRM companies - Spotzee\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns CRM company projections with public CRM properties only.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spotzee.mintlify.site/docs/_mintlify/api/og/v2?division=CRM\u0026amp;title=List+CRM+companies\u0026amp;description=Returns+CRM+company+projections+with+public+CRM+properties+only.\u0026amp;theme=6e26f6810543b3fc9ebb821a\u0026amp;signature=8924847cb8c07f15278d64e9bf0d8dd4ba747c920c26ff769ea02c2438c31efd\">\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/crm/list-crm-companies\">\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/crm/list-crm-companies.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/crm/list-crm-companies#webpage\",\"url\":\"https://spotzee.com/docs/api/crm/list-crm-companies\",\"name\":\"List CRM companies\",\"description\":\"Returns CRM company projections with public CRM properties only.\",\"dateModified\":\"2026-10-28T03:27:35.221Z\",\"isPartOf\":{\"@id\":\"https://spotzee.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://spotzee.com/docs/api/crm/list-crm-companies#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://spotzee.com/docs/api/crm/list-crm-companies#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CRM\",\"item\":\"https://spotzee.com/docs/api/crm/list-crm-properties\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List CRM companies\",\"item\":\"https://spotzee.com/docs/api/crm/list-crm-companies\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://spotzee.com/docs/api/crm/list-crm-companies#apireference\",\"headline\":\"List CRM companies\",\"name\":\"List CRM companies\",\"description\":\"Returns CRM company projections with public CRM properties only.\",\"url\":\"https://spotzee.com/docs/api/crm/list-crm-companies\",\"mainEntityOfPage\":{\"@id\":\"https://spotzee.com/docs/api/crm/list-crm-companies#webpage\"},\"dateModified\":\"2026-10-28T03:27:35.221Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","description":"Moves a CRM contact to a pipeline stage and records the stage-change activity.\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 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","description":"Creates a CRM company. POST is idempotent when called with an `Idempotency-Key` header.","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","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /templates/{templateId}/proof","href":"/api/templates/send-a-proof-of-a-template"}]},{"group":"Campaigns","icon":"paper-plane","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns","href":"/api/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /campaigns","href":"/api/campaigns/create-a-campaign"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns/{campaignId}","href":"/api/campaigns/get-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /campaigns/{campaignId}","href":"/api/campaigns/update-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /campaigns/{campaignId}","href":"/api/campaigns/delete-a-campaign"},{"title":"List campaign messages","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns/{campaignId}/recipients","href":"/api/campaigns/list-campaign-messages"},{"title":"Duplicate a campaign","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /campaigns/{campaignId}/duplicate","href":"/api/campaigns/duplicate-a-campaign"},{"title":"Render a campaign preview","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /campaigns/{campaignId}/preview","href":"/api/campaigns/render-a-campaign-preview"},{"title":"Trigger a campaign send for one user","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /campaigns/{campaignId}/trigger","href":"/api/campaigns/trigger-a-campaign-send-for-one-user"}]},{"group":"Journeys","icon":"route","pages":[{"title":"List journeys","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /journeys","href":"/api/journeys/list-journeys"},{"title":"Create a journey","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /journeys","href":"/api/journeys/create-a-journey"},{"title":"Get a journey","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /journeys/{journeyId}","href":"/api/journeys/get-a-journey"},{"title":"Update a journey","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /journeys/{journeyId}","href":"/api/journeys/update-a-journey"},{"title":"Delete a journey","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /journeys/{journeyId}","href":"/api/journeys/delete-a-journey"},{"title":"Trigger a journey entrance for one user","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /journeys/{journeyId}/trigger","href":"/api/journeys/trigger-a-journey-entrance-for-one-user"}]},{"group":"Tags","icon":"tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /tags","href":"/api/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /tags","href":"/api/tags/create-a-tag"},{"title":"Get a tag","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /tags/{tagId}","href":"/api/tags/get-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /tags/{tagId}","href":"/api/tags/update-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /tags/{tagId}","href":"/api/tags/delete-a-tag"}]},{"group":"API keys","icon":"key","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /keys","href":"/api/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /keys","href":"/api/api-keys/create-an-api-key"},{"title":"Get an API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /keys/{keyId}","href":"/api/api-keys/get-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /keys/{keyId}","href":"/api/api-keys/update-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /keys/{keyId}","href":"/api/api-keys/revoke-an-api-key"}]},{"group":"Organisation","icon":"building","pages":[{"title":"Get the current organisation","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/me","href":"/api/organisation/get-the-current-organisation"},{"title":"List organisation API keys","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/api-keys","href":"/api/organisation/list-organisation-api-keys"},{"title":"Create an organisation API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/api-keys","href":"/api/organisation/create-an-organisation-api-key"},{"title":"Get an organisation API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/api-keys/{keyId}","href":"/api/organisation/get-an-organisation-api-key"},{"title":"Update an organisation API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /organizations/api-keys/{keyId}","href":"/api/organisation/update-an-organisation-api-key"},{"title":"Revoke an organisation API key","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /organizations/api-keys/{keyId}","href":"/api/organisation/revoke-an-organisation-api-key"}]},{"group":"Webhooks","icon":"link","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /webhooks","href":"/api/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /webhooks","href":"/api/webhooks/create-a-webhook-endpoint"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /webhooks/{endpointId}/rotate-secret","href":"/api/webhooks/rotate-a-webhook-signing-secret"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /webhooks/{endpointId}","href":"/api/webhooks/get-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /webhooks/{endpointId}","href":"/api/webhooks/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /webhooks/{endpointId}","href":"/api/webhooks/delete-a-webhook-endpoint"}]},{"group":"Billing recovery","icon":"credit-card","pages":[{"title":"Get organisation recovery status","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/recoveries/status","href":"/api/billing-recovery/get-organisation-recovery-status"},{"title":"List project user contributions","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/recoveries/projects","href":"/api/billing-recovery/list-project-user-contributions"},{"title":"Search active users for recovery","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/recoveries/users","href":"/api/billing-recovery/search-active-users-for-recovery"},{"title":"Preview an immutable recovery archive selection","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/recoveries/users/archives/preview","href":"/api/billing-recovery/preview-an-immutable-recovery-archive-selection"},{"title":"Submit a verified recovery archive job","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/recoveries/users/archives","href":"/api/billing-recovery/submit-a-verified-recovery-archive-job"},{"title":"Get recovery job progress","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /organizations/recoveries/jobs/{jobId}","href":"/api/billing-recovery/get-recovery-job-progress"},{"title":"Retry an authoritative recovery recount","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/recoveries/jobs/{jobId}/recounts","href":"/api/billing-recovery/retry-an-authoritative-recovery-recount"},{"title":"Restore archived users when capacity permits","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /organizations/recoveries/users/restorations","href":"/api/billing-recovery/restore-archived-users-when-capacity-permits"}]},{"group":"Form definitions","icon":"clipboard-list","pages":[{"title":"List form definitions","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /form-definitions","href":"/api/form-definitions/list-form-definitions"},{"title":"Create a form definition","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /form-definitions","href":"/api/form-definitions/create-a-form-definition"},{"title":"Get a form definition","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json get /form-definitions/{formDefinitionId}","href":"/api/form-definitions/get-a-form-definition"},{"title":"Update a form definition","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json patch /form-definitions/{formDefinitionId}","href":"/api/form-definitions/update-a-form-definition"},{"title":"Delete a form definition","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json delete /form-definitions/{formDefinitionId}","href":"/api/form-definitions/delete-a-form-definition"}]},{"group":"Form submissions","icon":"file-circle-check","pages":[{"title":"Submit a public form","deprecated":null,"version":null,"openapi":"https://apix.spotzee.com/api/openapi.json post /forms/{publicToken}/submissions","href":"/api/form-submissions/submit-a-public-form"}]}]},{"tab":"Extended API","pages":[{"title":"Extended API","href":"/extended-api/introduction"}]}]},"basePath":"","title":"List CRM companies - Spotzee","buildId":"dpl_ATnXPMW25DMPUr9VBw6kL6MfBt6T","deploymentId":"dpl_ATnXPMW25DMPUr9VBw6kL6MfBt6T","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CNqlzjVB.js","utils-BqFiXZ79.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CnR4QBe6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BY2ZM1OO.js","snippetPresets-x-8ACO8V.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CTxrMSpo.js","ApiExamples-Ch-SJE05.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CqqG_0NE.js","shallow-BXrZ2b0C.js","getApiPlaygroundDisplay-n7J_wkjq.js","CodeSnippet-CQsp4vyQ.js","CodeSnippets-BfuHqvZx.js","getPastedJson-BjrGIK1i.js","icon-7iLZnVOC.js","MethodPill-TBS1m84e.js","DuplicateIcon-BNMrV4Vs.js","createIcon-C5kCqeU2.js","DynamicMarkdown-Bq09mRwR.js","SectionHeading-G4Bflf5Q.js","axios-vUo_bRtp.js","Markdown-BTUds0aX.js","clsx-6wHzaN2_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BPypQKlo.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-o6bee4ro.js"]}