Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign’s locations.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Spacebring Docs","colors":{"primary":"#00928F","light":"#7BEEB3","dark":"#00928F"},"logo":{"light":"https://mintcdn.com/spacebring/ElSlMekJ2CB5Dog7/logo/light.svg?fit=max\u0026auto=format\u0026n=ElSlMekJ2CB5Dog7\u0026q=85\u0026s=29b9c3bc15b6d346f2c13cccf246e486","dark":"https://mintcdn.com/spacebring/ElSlMekJ2CB5Dog7/logo/dark.svg?fit=max\u0026auto=format\u0026n=ElSlMekJ2CB5Dog7\u0026q=85\u0026s=fa94390626c2e4ed5dc7bcf5cbb80355"},"favicon":"https://mintcdn.com/spacebring/ElSlMekJ2CB5Dog7/favicon.svg?fit=max\u0026auto=format\u0026n=ElSlMekJ2CB5Dog7\u0026q=85\u0026s=3fbdcdb2b3743fb24f3b7b4e8824d364","footer":{"socials":{"github":"https://github.com/spacebring"}},"fonts":{"heading":{"family":"OktaNeue-SemiBold","weight":600,"source":"https://www.spacebring.com/OktaNeue-SemiBold.woff2","format":"woff2"},"body":{"family":"Inter"}},"integrations":{"cookies":{"key":"sb_analytics_consent","value":"granted"}},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spacebring","hasAudioNarration":false,"actualSubdomain":"spacebring","customDomains":["www.spacebring.com"],"gitSource":{"type":"github","owner":"spacebring","repo":"spacebring-mono","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af1cc2d2e1c4ffcdc0bca12","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Developer resources","count":235},{"language":"default","tag":"APIs","count":230},{"language":"default","tag":"Docs","count":210},{"language":"default","tag":"Admin experience","count":193},{"language":"default","tag":"Billing","count":83},{"language":"default","tag":"Integrations","count":46},{"language":"default","tag":"Invoices","count":28},{"language":"default","tag":"Guides","count":28},{"language":"default","tag":"Resources","count":28},{"language":"default","tag":"Payments","count":27}]},"assistantConfig":{},"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":false},"customCss":[{"filePath":"style.css","content":"[data-component-part=\"tab-content\"].hidden{display:block!important;visibility:hidden!important;height:0!important;overflow:hidden!important;pointer-events:none!important}"}],"page":{"pagePath":"developer/api/campaigns/get-a-campaign","slug":"/developer/api/campaigns/get-a-campaign","pageMetadata":{"title":"Get a campaign","description":"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign's locations. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>campaigns.readonly\u003c/code> or \u003ccode>campaigns\u003c/code>","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /campaigns/v1/{campaignId}","href":"/developer/api/campaigns/get-a-campaign","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign’s locations. \", _jsx(\"h3\", {\n children: \"OAuth\"\n }), \"Required scopes: \", _jsx(\"code\", {\n children: \"campaigns.readonly\"\n }), \" or \", _jsx(\"code\", {\n children: \"campaigns\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\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":"Get a campaign","description":"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign's locations. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>campaigns.readonly\u003c/code> or \u003ccode>campaigns\u003c/code>","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /campaigns/v1/{campaignId}","href":"/developer/api/campaigns/get-a-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Campaigns"],"summary":"Get a campaign","description":"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign's locations. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>campaigns.readonly\u003c/code> or \u003ccode>campaigns\u003c/code>","operationId":"getCampaign","parameters":["79f60c92-b850-4493-b86b-18b9a233d76d","d46de332-803c-400c-946f-7dd5424f488a"],"security":["19450b91-f59f-4bb8-93bc-810562bfe24d","5a5be9de-bf81-4013-a443-e39c26437c7f"],"responses":{"200":"d3635766-fa05-4491-9ea4-fe7fb633e344","400":"fc15dab5-37d6-418c-9345-4735f07a51cd","403":"bea6bfe3-7d40-4cd8-bda3-4780c3b37a93","404":"76739fe0-e083-4a1c-8c51-1ab12121b9e8"},"method":"get","type":"path","servers":["36a09d30-3486-4d25-a928-81db7ffeaa6f"],"path":"/campaigns/v1/{campaignId}","baseUrlOptions":["https://api.spacebring.com"],"title":"Get a campaign","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"79f60c92-b850-4493-b86b-18b9a233d76d":{"in":"path","name":"campaignId","required":true,"description":"ID of the campaign.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the campaign.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"d46de332-803c-400c-946f-7dd5424f488a":{"in":"header","name":"spacebring-network-id","schema":{"type":"string","format":"uuid","isRequired":false,"description":"The id of the network. Required when using bearer token authentication","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":false,"description":"The id of the network. Required when using bearer token authentication"}},"responses":{"d3635766-fa05-4491-9ea4-fe7fb633e344":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","properties":{"audience":{"type":"object","properties":{"locationRefs":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"campaign.audience.locationRefs.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"IDs of the locations whose active members the rules choose from.","isRequired":true,"uniqueKey":"campaign.audience.locationRefs","typeLabel":"string\u003cuuid>[]"},"rules":{"type":"array","items":{"oneOf":[{"type":"object","required":["companyRefs","type"],"properties":{"companyRefs":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.0.companyRefs.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"IDs of the companies whose people match.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.0.companyRefs","typeLabel":"string\u003cuuid>[]"},"type":{"type":"string","enum":["companies"],"description":"Members of the given companies.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["eventRefs","type"],"properties":{"eventRefs":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.1.eventRefs.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"IDs of the events whose attendees match.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.1.eventRefs","typeLabel":"string\u003cuuid>[]"},"type":{"type":"string","enum":["eventAttendees"],"description":"Attendees of the given events.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["membershipTypes","type"],"properties":{"membershipTypes":{"type":"array","items":{"type":"string","enum":["member","nonmember"],"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.2.membershipTypes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Membership types whose customers match.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.2.membershipTypes","typeLabel":"enum\u003cstring>[]"},"type":{"type":"string","enum":["membershipTypes"],"description":"Everyone at the locations with one of the given membership types.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["type","userRefs"],"properties":{"type":{"type":"string","enum":["people"],"description":"The given people.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"userRefs":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.3.userRefs.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"IDs of the users who match.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.3.userRefs","typeLabel":"string\u003cuuid>[]"}},"additionalProperties":false,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["planRefs","type"],"properties":{"planRefs":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.4.planRefs.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"IDs of the plans whose holders match.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.4.planRefs","typeLabel":"string\u003cuuid>[]"},"type":{"type":"string","enum":["plans"],"description":"People holding an active subscription to one of the given plans, personally or through their company.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["tierRefs","type"],"properties":{"tierRefs":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.5.tierRefs.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"IDs of the resource tiers whose holders match.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.5.tierRefs","typeLabel":"string\u003cuuid>[]"},"type":{"type":"string","enum":["resourceTiers"],"description":"People holding an active subscription to one of the given resource tiers, personally or through their company.","isRequired":true,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"campaign.audience.rules.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"campaign.audience.rules.items.[INDEX]","typeLabel":"object"},"description":"Rules a member or nonmember of the locations has to match at least one of. A person who matches several rules gets one message. With no rules, every active member of the locations matches, and no nonmember.","isRequired":true,"uniqueKey":"campaign.audience.rules","typeLabel":"object[]"}},"required":["locationRefs","rules"],"additionalProperties":false,"description":"Who receives the campaign.","isRequired":true,"uniqueKey":"campaign.audience","typeLabel":"object"},"channel":{"type":"string","enum":["email","push"],"description":"Channel the campaign is sent through.","isRequired":true,"uniqueKey":"campaign.channel","typeLabel":"enum\u003cstring>"},"createDate":{"type":"string","format":"date-time","description":"ISO timestamp of when the campaign was created.","isRequired":true,"uniqueKey":"campaign.createDate","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the campaign.","isRequired":true,"uniqueKey":"campaign.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name of the campaign, shown to admins only.","isRequired":true,"uniqueKey":"campaign.name","typeLabel":"string"},"stats":{"type":"object","properties":{"bounced":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of recipients whose email bounced.","isRequired":true,"uniqueKey":"campaign.stats.bounced","typeLabel":"integer"},"clicked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of recipients who clicked a link in the email at least once.","isRequired":true,"uniqueKey":"campaign.stats.clicked","typeLabel":"integer"},"complained":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of recipients who marked the email as spam.","isRequired":true,"uniqueKey":"campaign.stats.complained","typeLabel":"integer"},"delivered":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of recipients whose mail server accepted the email.","isRequired":true,"uniqueKey":"campaign.stats.delivered","typeLabel":"integer"},"opened":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of recipients who opened the email at least once.","isRequired":true,"uniqueKey":"campaign.stats.opened","typeLabel":"integer"},"recipients":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of people the campaign was sent to. Zero until sending starts.","isRequired":true,"uniqueKey":"campaign.stats.recipients","typeLabel":"integer"}},"required":["bounced","clicked","complained","delivered","opened","recipients"],"additionalProperties":false,"description":"Delivery statistics of the campaign.","isRequired":true,"uniqueKey":"campaign.stats","typeLabel":"object"},"status":{"type":"string","enum":["draft","scheduled","sending","sent","canceled","failed"],"description":"Stage of the campaign.","isRequired":true,"uniqueKey":"campaign.status","typeLabel":"enum\u003cstring>"},"updateDate":{"type":"string","format":"date-time","description":"ISO timestamp of when the campaign was last changed.","isRequired":true,"uniqueKey":"campaign.updateDate","typeLabel":"string\u003cdate-time>"},"charge":{"description":"What sending cost, debited from the network balance when sending started. Present for sent email campaigns.","type":"object","properties":{"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Amount debited, in minor units of the currency.","isRequired":true,"uniqueKey":"campaign.charge.amount","typeLabel":"integer"},"currencyCode":{"type":"string","description":"ISO 4217 currency code of the amount.","isRequired":true,"uniqueKey":"campaign.charge.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"additionalProperties":false,"uniqueKey":"campaign.charge","typeLabel":"object"},"createdBy":{"description":"Admin who created the campaign. Absent for a campaign created with client credentials.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the admin who created the campaign.","isRequired":true,"uniqueKey":"campaign.createdBy.id","typeLabel":"string\u003cuuid>"}},"required":["id"],"additionalProperties":false,"uniqueKey":"campaign.createdBy","typeLabel":"object"},"email":{"description":"Email content, used when the channel is email.","type":"object","properties":{"body":{"type":"string","description":"Body of the email, in the same markdown as a Feed post.","isRequired":true,"uniqueKey":"campaign.email.body","typeLabel":"string"},"subject":{"type":"string","description":"Subject of the email.","isRequired":true,"uniqueKey":"campaign.email.subject","typeLabel":"string"},"buttonLabel":{"description":"Label of the button below the body.","type":"string","uniqueKey":"campaign.email.buttonLabel","typeLabel":"string"},"buttonUrl":{"description":"Link the button opens.","type":"string","uniqueKey":"campaign.email.buttonUrl","typeLabel":"string"},"replyTo":{"description":"Address replies go to. Defaults to the network's email when omitted.","type":"string","uniqueKey":"campaign.email.replyTo","typeLabel":"string"}},"required":["body","subject"],"additionalProperties":false,"uniqueKey":"campaign.email","typeLabel":"object"},"push":{"description":"Push content, used when the channel is push.","type":"object","properties":{"body":{"type":"string","description":"Body of the push notification.","isRequired":true,"uniqueKey":"campaign.push.body","typeLabel":"string"},"title":{"type":"string","description":"Title of the push notification.","isRequired":true,"uniqueKey":"campaign.push.title","typeLabel":"string"},"link":{"description":"Link to the member web portal page the notification opens in the member app. The member app home when omitted.","type":"string","uniqueKey":"campaign.push.link","typeLabel":"string"}},"required":["body","title"],"additionalProperties":false,"uniqueKey":"campaign.push","typeLabel":"object"},"scheduleDate":{"description":"ISO timestamp of when the campaign is scheduled to be sent.","type":"string","format":"date-time","uniqueKey":"campaign.scheduleDate","typeLabel":"string\u003cdate-time>"},"sendDate":{"description":"ISO timestamp of when sending started.","type":"string","format":"date-time","uniqueKey":"campaign.sendDate","typeLabel":"string\u003cdate-time>"}},"required":["audience","channel","createDate","id","name","stats","status","updateDate"],"additionalProperties":false,"description":"The campaign.","isRequired":true,"uniqueKey":"campaign","typeLabel":"object"}},"required":["campaign"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"campaign":{"audience":{"locationRefs":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"rules":[{"companyRefs":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"type":"companies"}]},"channel":"email","createDate":"2023-11-07T05:31:56Z","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","stats":{"bounced":0,"clicked":0,"complained":0,"delivered":0,"opened":0,"recipients":0},"status":"draft","updateDate":"2023-11-07T05:31:56Z","charge":{"amount":0,"currencyCode":"\u003cstring>"},"createdBy":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"email":{"body":"\u003cstring>","subject":"\u003cstring>","buttonLabel":"\u003cstring>","buttonUrl":"\u003cstring>","replyTo":"\u003cstring>"},"push":{"body":"\u003cstring>","title":"\u003cstring>","link":"\u003cstring>"},"scheduleDate":"2023-11-07T05:31:56Z","sendDate":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fc15dab5-37d6-418c-9345-4735f07a51cd":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bea6bfe3-7d40-4cd8-bda3-4780c3b37a93":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"76739fe0-e083-4a1c-8c51-1ab12121b9e8":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"19450b91-f59f-4bb8-93bc-810562bfe24d":{"BasicAuth":{"type":"http","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication) for how to authorize your requests","scheme":"basic","scopes":[],"schemeName":"BasicAuth"}},"5a5be9de-bf81-4013-a443-e39c26437c7f":{"OAuth2":{"type":"oauth2","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2) for how to authorize your requests","flows":{"authorizationCode":{"authorizationUrl":"https://oauth2.spacebring.com/api/oauth2/authorize","tokenUrl":"https://oauth2.spacebring.com/api/oauth2/token","refreshUrl":"https://oauth2.spacebring.com/api/oauth2/token","scopes":{"benefits.readonly":"Read benefits and applications","benefits":"Read and write benefits and applications","campaigns.readonly":"Read campaigns","campaigns":"Read and write campaigns","checkIns.readonly":"Read check-ins","checkIns":"Read and write check-ins","community.readonly":"Read community companies and memberships","community":"Read and write community companies and memberships","events.readonly":"Read events and tickets","events":"Read and write events and tickets","feed.readonly":"Read feed posts","feed":"Read and write feed posts","invoices.readonly":"Read contracts, credit notes, discounts and invoices","invoices":"Read and write contract, credit notes, discounts and invoices","locations.readonly":"Read locations","locations":"Read and write locations","plans.readonly":"Read plans","plans":"Read and write plans","resources.readonly":"Read resources and bookings","resources":"Read and write resources and bookings","subscriptions.readonly":"Read subscriptions","subscriptions":"Read and write subscriptions","shop.readonly":"Read products and orders","shop":"Read and write products and orders","support.readonly":"Read support tickets","support":"Read and write support tickets","transactions.readonly":"Read transactions","transactions":"Read and write transactions","visitors.readonly":"Read visitors","visitors":"Read and write visitors"}}},"scopes":["campaigns.readonly","campaigns"],"schemeName":"OAuth2"}}},"servers":{"36a09d30-3486-4d25-a928-81db7ffeaa6f":{"url":"https://api.spacebring.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication) for how to authorize your requests","scheme":"basic","scopes":[],"schemeName":"BasicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication) for how to authorize your requests","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"},{"schemes":[{"scheme":{"type":"oauth2","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2) for how to authorize your requests","flows":{"authorizationCode":{"authorizationUrl":"https://oauth2.spacebring.com/api/oauth2/authorize","tokenUrl":"https://oauth2.spacebring.com/api/oauth2/token","refreshUrl":"https://oauth2.spacebring.com/api/oauth2/token","scopes":{"benefits.readonly":"Read benefits and applications","benefits":"Read and write benefits and applications","campaigns.readonly":"Read campaigns","campaigns":"Read and write campaigns","checkIns.readonly":"Read check-ins","checkIns":"Read and write check-ins","community.readonly":"Read community companies and memberships","community":"Read and write community companies and memberships","events.readonly":"Read events and tickets","events":"Read and write events and tickets","feed.readonly":"Read feed posts","feed":"Read and write feed posts","invoices.readonly":"Read contracts, credit notes, discounts and invoices","invoices":"Read and write contract, credit notes, discounts and invoices","locations.readonly":"Read locations","locations":"Read and write locations","plans.readonly":"Read plans","plans":"Read and write plans","resources.readonly":"Read resources and bookings","resources":"Read and write resources and bookings","subscriptions.readonly":"Read subscriptions","subscriptions":"Read and write subscriptions","shop.readonly":"Read products and orders","shop":"Read and write products and orders","support.readonly":"Read support tickets","support":"Read and write support tickets","transactions.readonly":"Read transactions","transactions":"Read and write transactions","visitors.readonly":"Read visitors","visitors":"Read and write visitors"}}},"scopes":["campaigns.readonly","campaigns"],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2) for how to authorize your requests","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"assets/openapi.json"},"subdomain":"spacebring","siteName":"Spacebring Docs","title":"Get a campaign - Spacebring Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T13:36:07.316Z","originalFileLocation":"developer/api/campaigns/get-a-campaign.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=\"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign\u0026#x27;s locations. OAuthRequired scopes: campaigns.readonly or campaigns\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spacebring Docs\">\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/spacebring/YJ_pXMVKGxwLzz_x/_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/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_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/spacebring/YJ_pXMVKGxwLzz_x/_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/spacebring/YJ_pXMVKGxwLzz_x/_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/spacebring/YJ_pXMVKGxwLzz_x/_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/spacebring/YJ_pXMVKGxwLzz_x/_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/spacebring/YJ_pXMVKGxwLzz_x/_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/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a campaign - Spacebring Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign\u0026#x27;s locations. OAuthRequired scopes: campaigns.readonly or campaigns\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spacebring Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spacebring.mintlify.site/docs/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+a+campaign\u0026amp;description=Get+a+campaign+by+its+id%2C+with+its+delivery+statistics+once+sending+starts.+With+bearer+token+authentication%2C+the+user+must+be+an+administrator+who+can+view+cam\u0026amp;theme=d0b0508e0910b4cedd4270e7\u0026amp;signature=08bb73162bbc5ed3c56c397c667084ac99ba07cbc3b2bb8c03abc7443ddaa551\">\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=\"Get a campaign - Spacebring Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign\u0026#x27;s locations. OAuthRequired scopes: campaigns.readonly or campaigns\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spacebring.mintlify.site/docs/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+a+campaign\u0026amp;description=Get+a+campaign+by+its+id%2C+with+its+delivery+statistics+once+sending+starts.+With+bearer+token+authentication%2C+the+user+must+be+an+administrator+who+can+view+cam\u0026amp;theme=d0b0508e0910b4cedd4270e7\u0026amp;signature=08bb73162bbc5ed3c56c397c667084ac99ba07cbc3b2bb8c03abc7443ddaa551\">\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/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spacebring Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00928F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/developer/api/campaigns/get-a-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.spacebring.com/#organization\",\"name\":\"Spacebring Docs\",\"url\":\"https://www.spacebring.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spacebring/ElSlMekJ2CB5Dog7/logo/light.svg?fit=max\u0026auto=format\u0026n=ElSlMekJ2CB5Dog7\u0026q=85\u0026s=29b9c3bc15b6d346f2c13cccf246e486\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.spacebring.com/docs#website\",\"name\":\"Spacebring Docs\",\"url\":\"https://www.spacebring.com/docs\",\"publisher\":{\"@id\":\"https://www.spacebring.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign#webpage\",\"url\":\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign\",\"name\":\"Get a campaign\",\"description\":\"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign's locations. OAuthRequired scopes: campaigns.readonly or campaigns\",\"dateModified\":\"2026-11-09T13:36:07.316Z\",\"isPartOf\":{\"@id\":\"https://www.spacebring.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://www.spacebring.com/docs/developer/api/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Campaigns\",\"item\":\"https://www.spacebring.com/docs/developer/api/campaigns/retrieve-campaigns\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a campaign\",\"item\":\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign#apireference\",\"headline\":\"Get a campaign\",\"name\":\"Get a campaign\",\"description\":\"Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign's locations. OAuthRequired scopes: campaigns.readonly or campaigns\",\"url\":\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://www.spacebring.com/docs/developer/api/campaigns/get-a-campaign#webpage\"},\"dateModified\":\"2026-11-09T13:36:07.316Z\",\"publisher\":{\"@id\":\"https://www.spacebring.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.spacebring.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spacebring Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spacebring Docs","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/automate-onboarding-and-follow-ups"}]},{"tab":"Developer resources","groups":[{"group":"Overview","boost":0.1,"pages":[{"title":"Introduction","icon":"code","href":"/developer"},{"title":"Guides","icon":"map","href":"/developer/guides"},{"title":"Changelog","icon":"clock-rotate-left","href":"/developer/changelog"}]},{"group":"APIs","boost":0.1,"pages":[{"title":"Authentication","href":"/developer/api/authentication"},{"title":"Pagination","href":"/developer/api/pagination"},{"title":"Rate limiting","href":"/developer/api/rate-limiting"},{"title":"File uploads","href":"/developer/api/file-uploads"},{"title":"OpenAPI spec","href":"/developer/api/openapi-spec"},{"group":"Alternative currencies","pages":[{"title":"Retrieve alternative currencies","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /alt_currencies/v1","href":"/developer/api/alternative-currencies/retrieve-alternative-currencies"},{"title":"Create an alternative currency","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /alt_currencies/v1","href":"/developer/api/alternative-currencies/create-an-alternative-currency"},{"title":"Retrieve an alternative currency","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /alt_currencies/v1/{id}","href":"/developer/api/alternative-currencies/retrieve-an-alternative-currency"},{"title":"Delete an alternative currency","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /alt_currencies/v1/{id}","href":"/developer/api/alternative-currencies/delete-an-alternative-currency"},{"title":"Update an alternative currency","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /alt_currencies/v1/{id}","href":"/developer/api/alternative-currencies/update-an-alternative-currency"}]},{"group":"Benefits","pages":[{"title":"Retrieve categories","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/categories/v1","href":"/developer/api/benefits/retrieve-categories"},{"title":"Create a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /benefits/categories/v1","href":"/developer/api/benefits/create-a-category"},{"title":"Get a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/categories/v1/{categoryId}","href":"/developer/api/benefits/get-a-category"},{"title":"Update a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /benefits/categories/v1/{categoryId}","href":"/developer/api/benefits/update-a-category"},{"title":"Delete a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /benefits/categories/v1/{categoryId}","href":"/developer/api/benefits/delete-a-category"},{"title":"Retrieve benefits","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/v1","href":"/developer/api/benefits/retrieve-benefits"},{"title":"Create a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /benefits/v1","href":"/developer/api/benefits/create-a-benefit"},{"title":"Retrieve a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/v1/{benefitId}","href":"/developer/api/benefits/retrieve-a-benefit"},{"title":"Update a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /benefits/v1/{benefitId}","href":"/developer/api/benefits/update-a-benefit"},{"title":"Delete a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /benefits/v1/{benefitId}","href":"/developer/api/benefits/delete-a-benefit"},{"title":"Partially update a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /benefits/v1/{benefitId}","href":"/developer/api/benefits/partially-update-a-benefit"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /benefits/v1/media","href":"/developer/api/benefits/create-a-media-upload"},{"title":"Retrieve applications","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/applications/v1","href":"/developer/api/benefits/retrieve-applications"},{"title":"Apply for a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /benefits/applications/v1","href":"/developer/api/benefits/apply-for-a-benefit"},{"title":"Retrieve an application","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/applications/v1/{benefitApplicationId}","href":"/developer/api/benefits/retrieve-an-application"}]},{"group":"Billing","pages":[{"title":"Retrieve invoices","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1","href":"/developer/api/billing/retrieve-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1","href":"/developer/api/billing/create-an-invoice"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/{invoiceId}","href":"/developer/api/billing/retrieve-an-invoice"},{"title":"Delete an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /billing/invoices/v1/{invoiceId}","href":"/developer/api/billing/delete-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /billing/invoices/v1/{invoiceId}","href":"/developer/api/billing/update-an-invoice"},{"title":"Cancel a payment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/cancel_payment","href":"/developer/api/billing/cancel-a-payment"},{"title":"Duplicate an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/duplicate","href":"/developer/api/billing/duplicate-an-invoice"},{"title":"Issue an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/issue","href":"/developer/api/billing/issue-an-invoice"},{"title":"Pay an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/pay","href":"/developer/api/billing/pay-an-invoice"},{"title":"Resend an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/resend","href":"/developer/api/billing/resend-an-invoice"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /billing/invoices/v1/{invoiceId}/void","href":"/developer/api/billing/void-an-invoice"},{"title":"List invoice items","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/items","href":"/developer/api/billing/list-invoice-items"},{"title":"Create an invoice item","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/items","href":"/developer/api/billing/create-an-invoice-item"},{"title":"Retrieve an invoice item","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/items/{id}","href":"/developer/api/billing/retrieve-an-invoice-item"},{"title":"Delete an invoice item","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /billing/invoices/v1/items/{id}","href":"/developer/api/billing/delete-an-invoice-item"},{"title":"Update an invoice item","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /billing/invoices/v1/items/{id}","href":"/developer/api/billing/update-an-invoice-item"},{"title":"List upcoming invoice items","deprecated":true,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/items/upcoming","href":"/developer/api/billing/list-upcoming-invoice-items"},{"title":"Retrieve the upcoming invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/upcoming","href":"/developer/api/billing/retrieve-the-upcoming-invoice"},{"title":"Retrieve credit notes","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/credit_notes/v1","href":"/developer/api/billing/retrieve-credit-notes"},{"title":"Create a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/credit_notes/v1","href":"/developer/api/billing/create-a-credit-note"},{"title":"Retrieve a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/credit_notes/v1/{id}","href":"/developer/api/billing/retrieve-a-credit-note"},{"title":"Update a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /billing/credit_notes/v1/{id}","href":"/developer/api/billing/update-a-credit-note"},{"title":"Void a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /billing/credit_notes/v1/{id}/void","href":"/developer/api/billing/void-a-credit-note"},{"title":"Preview a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/credit_notes/v1/preview","href":"/developer/api/billing/preview-a-credit-note"}]},{"group":"Campaigns","pages":[{"title":"Retrieve campaigns","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /campaigns/v1","href":"/developer/api/campaigns/retrieve-campaigns"},{"title":"Create a campaign","description":"Create a campaign as a draft, which an administrator sends from the admin web portal: the API cannot send, test, or schedule a campaign. A draft can be saved before its content is complete. A campaign created with basic authentication has no \u003ccode>createdBy\u003c/code>. With bearer token authentication, the user must be an administrator who can manage campaigns in every location of the audience. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>campaigns\u003c/code>","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /campaigns/v1","href":"/developer/api/campaigns/create-a-campaign"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /campaigns/v1/{campaignId}","href":"/developer/api/campaigns/get-a-campaign"},{"title":"Delete a campaign","description":"Delete a draft or cancelled campaign. A campaign that is scheduled, sending, sent, or failed cannot be deleted. With bearer token authentication, the user must be an administrator who can manage campaigns in every location of the audience. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>campaigns\u003c/code>","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /campaigns/v1/{campaignId}","href":"/developer/api/campaigns/delete-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /campaigns/v1/{campaignId}","href":"/developer/api/campaigns/update-a-campaign"}]},{"group":"Check-ins","pages":[{"title":"Retrieve check-ins","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /check_ins/v1","href":"/developer/api/check-ins/retrieve-check-ins"},{"title":"Get a check-in","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /check_ins/v1/{checkInId}","href":"/developer/api/check-ins/get-a-check-in"},{"title":"Update a check-in","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /check_ins/v1/{checkInId}","href":"/developer/api/check-ins/update-a-check-in"},{"title":"Check in","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /check_ins/v1/checkin","href":"/developer/api/check-ins/check-in"},{"title":"Check out","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /check_ins/v1/checkout","href":"/developer/api/check-ins/check-out"}]},{"group":"Community","pages":[{"title":"Retrieve companies","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/companies/v1","href":"/developer/api/community/retrieve-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /community/companies/v1","href":"/developer/api/community/create-a-company"},{"title":"Retrieve a company","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/companies/v1/{id}","href":"/developer/api/community/retrieve-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /community/companies/v1/{id}","href":"/developer/api/community/update-a-company"},{"title":"Create a logo upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /community/companies/v1/media","href":"/developer/api/community/create-a-logo-upload"},{"title":"Retrieve memberships","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/memberships/v1","href":"/developer/api/community/retrieve-memberships"},{"title":"Create a membership","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /community/memberships/v1","href":"/developer/api/community/create-a-membership"},{"title":"Retrieve a membership","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/memberships/v1/{id}","href":"/developer/api/community/retrieve-a-membership"},{"title":"Update a membership","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /community/memberships/v1/{id}","href":"/developer/api/community/update-a-membership"},{"title":"Delete a membership","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /community/memberships/v1/{id}","href":"/developer/api/community/delete-a-membership"},{"title":"Retrieve deleted memberships","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/memberships/v1/deleted","href":"/developer/api/community/retrieve-deleted-memberships"}]},{"group":"Contracts","pages":[{"title":"Retrieve contracts","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /contracts/v1","href":"/developer/api/contracts/retrieve-contracts"},{"title":"Create a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/v1","href":"/developer/api/contracts/create-a-contract"},{"title":"Get a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /contracts/v1/{contractId}","href":"/developer/api/contracts/get-a-contract"},{"title":"Delete a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /contracts/v1/{contractId}","href":"/developer/api/contracts/delete-a-contract"},{"title":"Update a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /contracts/v1/{contractId}","href":"/developer/api/contracts/update-a-contract"},{"title":"Issue a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/v1/{contractId}/issue","href":"/developer/api/contracts/issue-a-contract"},{"title":"Resend a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/v1/{contractId}/resend","href":"/developer/api/contracts/resend-a-contract"},{"title":"Decline a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /contracts/v1/{contractId}/signers/{signerId}/decline","href":"/developer/api/contracts/decline-a-contract"},{"title":"Sign a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /contracts/v1/{contractId}/signers/{signerId}/sign","href":"/developer/api/contracts/sign-a-contract"},{"title":"Terminate a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /contracts/v1/{contractId}/terminate","href":"/developer/api/contracts/terminate-a-contract"},{"title":"Retrieve templates","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /contracts/templates/v1","href":"/developer/api/contracts/retrieve-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/templates/v1","href":"/developer/api/contracts/create-a-template"},{"title":"Create a template upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/templates/v1/media","href":"/developer/api/contracts/create-a-template-upload"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /contracts/templates/v1/{templateId}","href":"/developer/api/contracts/retrieve-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /contracts/templates/v1/{templateId}","href":"/developer/api/contracts/delete-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /contracts/templates/v1/{templateId}","href":"/developer/api/contracts/update-a-template"},{"title":"Duplicate a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/templates/v1/{templateId}/duplicate","href":"/developer/api/contracts/duplicate-a-template"}]},{"group":"Discounts","pages":[{"title":"Retrieve coupons","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/coupons","href":"/developer/api/discounts/retrieve-coupons"},{"title":"Create a coupon","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /discounts/v1/coupons","href":"/developer/api/discounts/create-a-coupon"},{"title":"Get a coupon","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/coupons/{id}","href":"/developer/api/discounts/get-a-coupon"},{"title":"Delete a coupon","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /discounts/v1/coupons/{id}","href":"/developer/api/discounts/delete-a-coupon"},{"title":"Update a coupon","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /discounts/v1/coupons/{id}","href":"/developer/api/discounts/update-a-coupon"},{"title":"Retrieve promocodes","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/promocodes","href":"/developer/api/discounts/retrieve-promocodes"},{"title":"Create a promocode","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /discounts/v1/promocodes","href":"/developer/api/discounts/create-a-promocode"},{"title":"Get a promocode","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/promocodes/{id}","href":"/developer/api/discounts/get-a-promocode"},{"title":"Archive a promocode","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /discounts/v1/promocodes/{id}/archive","href":"/developer/api/discounts/archive-a-promocode"},{"title":"Retrieve redemptions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/redemptions","href":"/developer/api/discounts/retrieve-redemptions"}]},{"group":"Events","pages":[{"title":"Retrieve events","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /events/v1","href":"/developer/api/events/retrieve-events"},{"title":"Create an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /events/v1","href":"/developer/api/events/create-an-event"},{"title":"Retrieve an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /events/v1/{id}","href":"/developer/api/events/retrieve-an-event"},{"title":"Update an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /events/v1/{id}","href":"/developer/api/events/update-an-event"},{"title":"Delete an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /events/v1/{id}","href":"/developer/api/events/delete-an-event"},{"title":"Partially update an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /events/v1/{id}","href":"/developer/api/events/partially-update-an-event"},{"title":"Cancel an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /events/v1/{id}/cancel","href":"/developer/api/events/cancel-an-event"},{"title":"Copy an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /events/v1/{id}/copy","href":"/developer/api/events/copy-an-event"},{"title":"Add event hosts","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /events/v1/{id}/hosts","href":"/developer/api/events/add-event-hosts"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /events/v1/media","href":"/developer/api/events/create-a-media-upload"},{"title":"Retrieve tickets","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /events/tickets/v1","href":"/developer/api/events/retrieve-tickets"},{"title":"Retrieve a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /events/tickets/v1/{id}","href":"/developer/api/events/retrieve-a-ticket"},{"title":"Update a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /events/tickets/v1/{id}","href":"/developer/api/events/update-a-ticket"},{"title":"Delete a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /events/tickets/v1/{id}","href":"/developer/api/events/delete-a-ticket"},{"title":"Check in a ticket","deprecated":true,"version":null,"openapi":"/assets/openapi.json post /events/tickets/v1/{id}/checkin","href":"/developer/api/events/check-in-a-ticket"}]},{"group":"Feed","pages":[{"title":"Get posts","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /feed/posts/v1","href":"/developer/api/feed/get-posts"},{"title":"Create a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/posts/v1","href":"/developer/api/feed/create-a-post"},{"title":"Get a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /feed/posts/v1/{id}","href":"/developer/api/feed/get-a-post"},{"title":"Update a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /feed/posts/v1/{id}","href":"/developer/api/feed/update-a-post"},{"title":"Delete a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /feed/posts/v1/{id}","href":"/developer/api/feed/delete-a-post"},{"title":"Partially update a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /feed/posts/v1/{id}","href":"/developer/api/feed/partially-update-a-post"},{"title":"Get comments for a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /feed/posts/v1/{id}/comments","href":"/developer/api/feed/get-comments-for-a-post"},{"title":"Get likes for a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /feed/posts/v1/{id}/likes","href":"/developer/api/feed/get-likes-for-a-post"},{"title":"Create a like for a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/posts/v1/{id}/likes","href":"/developer/api/feed/create-a-like-for-a-post"},{"title":"Delete a like for a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /feed/posts/v1/{id}/likes","href":"/developer/api/feed/delete-a-like-for-a-post"},{"title":"Create a post comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/comments/v1","href":"/developer/api/feed/create-a-post-comment"},{"title":"Delete a post comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /feed/comments/v1/{id}","href":"/developer/api/feed/delete-a-post-comment"},{"title":"Create a like for a post comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/comments/v1/{id}/likes","href":"/developer/api/feed/create-a-like-for-a-post-comment"},{"title":"Delete a like for a post comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /feed/comments/v1/{id}/likes","href":"/developer/api/feed/delete-a-like-for-a-post-comment"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/v1/media","href":"/developer/api/feed/create-a-media-upload"}]},{"group":"Floors","pages":[{"title":"Get floors","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /floors/v1","href":"/developer/api/floors/get-floors"},{"title":"Delete a floor","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /floors/v1/{id}","href":"/developer/api/floors/delete-a-floor"}]},{"group":"Guides","pages":[{"title":"Retrieve guides","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /guides/v1","href":"/developer/api/guides/retrieve-guides"},{"title":"Create a guide","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /guides/v1","href":"/developer/api/guides/create-a-guide"},{"title":"Retrieve a guide","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /guides/v1/{guideId}","href":"/developer/api/guides/retrieve-a-guide"},{"title":"Delete a guide","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /guides/v1/{guideId}","href":"/developer/api/guides/delete-a-guide"},{"title":"Update a guide","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /guides/v1/{guideId}","href":"/developer/api/guides/update-a-guide"},{"title":"Create an attachment upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /guides/v1/attachments","href":"/developer/api/guides/create-an-attachment-upload"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /guides/v1/media","href":"/developer/api/guides/create-a-media-upload"}]},{"group":"Locations","pages":[{"title":"Retrieve all locations","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /locations/v1","href":"/developer/api/locations/retrieve-all-locations"},{"title":"Get a location","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /locations/v1/{locationId}","href":"/developer/api/locations/get-a-location"}]},{"group":"Networks","pages":[{"title":"Retrieve networks","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /networks/v1","href":"/developer/api/networks/retrieve-networks"}]},{"group":"Packages","pages":[{"title":"Retrieve packages","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /packages/v1","href":"/developer/api/packages/retrieve-packages"},{"title":"Create a package","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /packages/v1","href":"/developer/api/packages/create-a-package"},{"title":"Retrieve a package","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /packages/v1/{packageId}","href":"/developer/api/packages/retrieve-a-package"},{"title":"Delete a package","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /packages/v1/{packageId}","href":"/developer/api/packages/delete-a-package"},{"title":"Update a package","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /packages/v1/{packageId}","href":"/developer/api/packages/update-a-package"}]},{"group":"Plans","pages":[{"title":"Retrieve plans","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /plans/v1","href":"/developer/api/plans/retrieve-plans"},{"title":"Create a plan","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /plans/v1","href":"/developer/api/plans/create-a-plan"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /plans/v1/media","href":"/developer/api/plans/create-a-media-upload"},{"title":"Retrieve a plan","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /plans/v1/{planId}","href":"/developer/api/plans/retrieve-a-plan"},{"title":"Delete a plan","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /plans/v1/{planId}","href":"/developer/api/plans/delete-a-plan"},{"title":"Update a plan","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /plans/v1/{planId}","href":"/developer/api/plans/update-a-plan"}]},{"group":"Registrations","pages":[{"title":"Retrieve registrations","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /registrations/v1","href":"/developer/api/registrations/retrieve-registrations"}]},{"group":"Resources","pages":[{"title":"Retrieve resources","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/v1","href":"/developer/api/resources/retrieve-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/v1","href":"/developer/api/resources/create-a-resource"},{"title":"Retrieve resource assignments","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/v1/assignments","href":"/developer/api/resources/retrieve-resource-assignments"},{"title":"Create a resource assignment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/v1/assignments","href":"/developer/api/resources/create-a-resource-assignment"},{"title":"Get a resource assignment","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/v1/assignments/{assignmentId}","href":"/developer/api/resources/get-a-resource-assignment"},{"title":"Delete a resource assignment","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /resources/v1/assignments/{assignmentId}","href":"/developer/api/resources/delete-a-resource-assignment"},{"title":"Update a resource assignment","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /resources/v1/assignments/{assignmentId}","href":"/developer/api/resources/update-a-resource-assignment"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/v1/media","href":"/developer/api/resources/create-a-media-upload"},{"title":"Get a resource","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/v1/{resourceId}","href":"/developer/api/resources/get-a-resource"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /resources/v1/{resourceId}","href":"/developer/api/resources/delete-a-resource"},{"title":"Patch a resource","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /resources/v1/{resourceId}","href":"/developer/api/resources/patch-a-resource"},{"title":"Check resource availability","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/v1/{resourceId}/availability","href":"/developer/api/resources/check-resource-availability"},{"title":"Retrieve bookings","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/bookings/v1","href":"/developer/api/resources/retrieve-bookings"},{"title":"Create a booking","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/bookings/v1","href":"/developer/api/resources/create-a-booking"},{"title":"Get a booking","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/bookings/v1/{bookingId}","href":"/developer/api/resources/get-a-booking"},{"title":"Delete a booking","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /resources/bookings/v1/{bookingId}","href":"/developer/api/resources/delete-a-booking"},{"title":"Update a booking","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /resources/bookings/v1/{bookingId}","href":"/developer/api/resources/update-a-booking"}]},{"group":"Shop","pages":[{"title":"Retrieve categories","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/categories/v1","href":"/developer/api/shop/retrieve-categories"},{"title":"Create a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /shop/categories/v1","href":"/developer/api/shop/create-a-category"},{"title":"Get a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/categories/v1/{categoryId}","href":"/developer/api/shop/get-a-category"},{"title":"Update a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /shop/categories/v1/{categoryId}","href":"/developer/api/shop/update-a-category"},{"title":"Delete a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /shop/categories/v1/{categoryId}","href":"/developer/api/shop/delete-a-category"},{"title":"Retrieve products","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/products/v1","href":"/developer/api/shop/retrieve-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /shop/products/v1","href":"/developer/api/shop/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/products/v1/{productId}","href":"/developer/api/shop/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /shop/products/v1/{productId}","href":"/developer/api/shop/update-a-product"},{"title":"Delete a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /shop/products/v1/{productId}","href":"/developer/api/shop/delete-a-product"},{"title":"Partially update a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /shop/products/v1/{productId}","href":"/developer/api/shop/partially-update-a-product"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /shop/products/v1/media","href":"/developer/api/shop/create-a-media-upload"},{"title":"Retrieve orders","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/orders/v1","href":"/developer/api/shop/retrieve-orders"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/orders/v1/{orderId}","href":"/developer/api/shop/get-an-order"}]},{"group":"Subscriptions","pages":[{"title":"Retrieve subscriptions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /subscriptions/v1","href":"/developer/api/subscriptions/retrieve-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /subscriptions/v1","href":"/developer/api/subscriptions/create-a-subscription"},{"title":"Retrieve a subscription","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /subscriptions/v1/{subscriptionId}","href":"/developer/api/subscriptions/retrieve-a-subscription"},{"title":"Delete a subscription","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /subscriptions/v1/{subscriptionId}","href":"/developer/api/subscriptions/delete-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /subscriptions/v1/{subscriptionId}","href":"/developer/api/subscriptions/update-a-subscription"},{"title":"Create a subscription item","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /subscriptions/v1/{subscriptionId}/items","href":"/developer/api/subscriptions/create-a-subscription-item"},{"title":"Delete a subscription item","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /subscriptions/v1/{subscriptionId}/items/{itemId}","href":"/developer/api/subscriptions/delete-a-subscription-item"},{"title":"Update a subscription item","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /subscriptions/v1/{subscriptionId}/items/{itemId}","href":"/developer/api/subscriptions/update-a-subscription-item"}]},{"group":"Support","pages":[{"title":"Retrieve tickets","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /support/tickets/v1","href":"/developer/api/support/retrieve-tickets"},{"title":"Create a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /support/tickets/v1","href":"/developer/api/support/create-a-ticket"},{"title":"Retrieve a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /support/tickets/v1/{id}","href":"/developer/api/support/retrieve-a-ticket"},{"title":"Update a ticket's assignee","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /support/tickets/v1/{id}/assignee","href":"/developer/api/support/update-a-tickets-assignee"},{"title":"Update a ticket's status","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /support/tickets/v1/{id}/status","href":"/developer/api/support/update-a-tickets-status"},{"title":"Update a ticket's type","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /support/tickets/v1/{id}/type","href":"/developer/api/support/update-a-tickets-type"},{"title":"Create a ticket comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /support/tickets/v1/comment","href":"/developer/api/support/create-a-ticket-comment"},{"title":"Delete a ticket comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /support/tickets/v1/comment/{id}","href":"/developer/api/support/delete-a-ticket-comment"},{"title":"Update a ticket comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /support/tickets/v1/comment/{id}","href":"/developer/api/support/update-a-ticket-comment"},{"title":"Create a ticket media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /support/tickets/v1/media","href":"/developer/api/support/create-a-ticket-media-upload"}]},{"group":"Transactions","pages":[{"title":"Retrieve scheduled credits transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/credits/scheduled/v1","href":"/developer/api/transactions/retrieve-scheduled-credits-transactions"},{"title":"Retrieve credit transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/credits/v1","href":"/developer/api/transactions/retrieve-credit-transactions"},{"title":"Create a credit transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /transactions/credits/v1","href":"/developer/api/transactions/create-a-credit-transaction"},{"title":"Retrieve a credit transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/credits/v1/{id}","href":"/developer/api/transactions/retrieve-a-credit-transaction"},{"title":"Retrieve scheduled day pass transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/day_passes/scheduled/v1","href":"/developer/api/transactions/retrieve-scheduled-day-pass-transactions"},{"title":"Retrieve day pass transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/day_passes/v1","href":"/developer/api/transactions/retrieve-day-pass-transactions"},{"title":"Create a day pass transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /transactions/day_passes/v1","href":"/developer/api/transactions/create-a-day-pass-transaction"},{"title":"Retrieve a day pass transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/day_passes/v1/{id}","href":"/developer/api/transactions/retrieve-a-day-pass-transaction"},{"title":"Retrieve money transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/money/v1","href":"/developer/api/transactions/retrieve-money-transactions"},{"title":"Create a money transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /transactions/money/v1","href":"/developer/api/transactions/create-a-money-transaction"},{"title":"Retrieve a money transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/money/v1/{transactionId}","href":"/developer/api/transactions/retrieve-a-money-transaction"},{"title":"Update a money transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /transactions/money/v1/{transactionId}","href":"/developer/api/transactions/update-a-money-transaction"},{"title":"Refund a money transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /transactions/money/v1/{transactionId}/refund","href":"/developer/api/transactions/refund-a-money-transaction"},{"title":"Retrieve credit balance","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/v1/balances/{id}/credits","href":"/developer/api/transactions/retrieve-credit-balance"},{"title":"Retrieve day passes balance","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/v1/balances/{id}/day_passes","href":"/developer/api/transactions/retrieve-day-passes-balance"}]},{"group":"Visitors","pages":[{"title":"Get contacts","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/contacts/v1","href":"/developer/api/visitors/get-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/contacts/v1","href":"/developer/api/visitors/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/contacts/v1/{contactId}","href":"/developer/api/visitors/get-a-contact"},{"title":"Get requests","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/requests/v1","href":"/developer/api/visitors/get-requests"},{"title":"Create a request","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/requests/v1","href":"/developer/api/visitors/create-a-request"},{"title":"Retrieve a request","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/requests/v1/{id}","href":"/developer/api/visitors/retrieve-a-request"},{"title":"Approve a request","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/requests/v1/{id}/approve","href":"/developer/api/visitors/approve-a-request"},{"title":"Reject a request","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/requests/v1/{id}/reject","href":"/developer/api/visitors/reject-a-request"},{"title":"Retrieve visits","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/visits/v1","href":"/developer/api/visitors/retrieve-visits"},{"title":"Create a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/visits/v1","href":"/developer/api/visitors/create-a-visit"},{"title":"Retrieve a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/visits/v1/{id}","href":"/developer/api/visitors/retrieve-a-visit"},{"title":"Update a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /visitors/visits/v1/{id}","href":"/developer/api/visitors/update-a-visit"},{"title":"Delete a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /visitors/visits/v1/{id}","href":"/developer/api/visitors/delete-a-visit"},{"title":"Check in a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/visits/v1/checkin","href":"/developer/api/visitors/check-in-a-visit"},{"title":"Check out a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/visits/v1/checkout","href":"/developer/api/visitors/check-out-a-visit"}]}]},{"group":"Webhooks","boost":0.1,"pages":[{"title":"Overview","href":"/developer/webhooks/index"},{"title":"Verifying webhooks requests","href":"/developer/webhooks/verifying"}]}]},{"tab":"Contact us","href":"mailto:support@spacebring.com"}]},"basePath":"","title":"Get a campaign - Spacebring Docs","buildId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","deploymentId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_7my4bd.js","utils-Cq_itTNA.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B5KPEvGz.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DBX-JepP.js","snippetPresets-Bsspz-Ge.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-jcs-2nGf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dp53in7F.js","shallow-Dv9eUdUd.js","getApiPlaygroundDisplay-D8cDwNhi.js","CodeSnippet-DkwXLQor.js","CodeSnippets-DcSgKqs5.js","Page-t8ynOKTD.js","getPastedJson-I2RjoApV.js","icon-BIj57rZC.js","MethodPill-CTwLPWXC.js","DuplicateIcon-BJpFwygY.js","createIcon-C7PorfAe.js","DynamicMarkdown-BBht_uEs.js","SectionHeading-YIBwxbzj.js","axios-vUo_bRtp.js","Markdown--YCeFtOs.js","clsx-CrPa459s.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BWxsj3I0.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fBzVvq7k.js"]}