Set up your API key, configure requests, and call your first endpoint
This guide walks you through using the Choicely Developer API. By following these steps, you’ll set up your API key, configure your requests, and interact with the various API endpoints to integrate seamlessly with the platform.
Step 1: Generate your Developer API key
To begin using the Developer API, generate an API key with the necessary permissions:
Go to your account’s Manage Account.
In Linked accounts, select Developer API and create your API key.
Choose the permissions your API key should have based on your integration needs.
Copy the generated API key and store it securely — you’ll need it for configuring requests.
Store your API key securely and never expose it in client-side code. Treat it like a password.
Step 2: Configure your request with the API key
Use your API key as a Bearer token in the request header to authenticate your calls:
Authorization: Bearer <YOUR_API_KEY>
This header ensures that each API request is authorized and processed securely. See Authentication for details.
Step 3: Browse the documentation
Explore the resource pages to find the available endpoints. Each endpoint includes:
A description of the endpoint’s functionality
Required headers, parameters, and permissions
Sample payloads for reference
Step 4: Choose your endpoint and HTTP method
Find the endpoint you want to use based on your integration requirements:
Available endpoints:/apps, /articles, /contests, and others.
HTTP methods: Identify the method required for each endpoint, such as GET, POST, PATCH, etc.
For example:
POST /appsGET /apps/<app_key>PATCH /apps/<app_key>
Step 5: Experiment with sample payloads
Each resource page provides a sample payload to help you format your data:
Request body: Use the sample payload as a guide for structuring your request.
Customization: Adjust fields within the payload to meet your requirements.
Testing: Try sending requests with sample payloads in Postman or any HTTP client.
Now you’re ready to start integrating with the Choicely Developer API. For any questions, refer to the resource pages or reach out to support@choicely.com for further assistance.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Choicely Mobile SDK","colors":{"primary":"#00D68F","light":"#00FFB3","dark":"#00B377"},"logo":{"light":"https://mintcdn.com/choicely/5ATW2QVKA6uvu958/logo/choicely-logo.png?fit=max\u0026auto=format\u0026n=5ATW2QVKA6uvu958\u0026q=85\u0026s=486af2e5a68e76f999f2a74137a537af","dark":"https://mintcdn.com/choicely/5ATW2QVKA6uvu958/logo/choicely-logo.png?fit=max\u0026auto=format\u0026n=5ATW2QVKA6uvu958\u0026q=85\u0026s=486af2e5a68e76f999f2a74137a537af"},"favicon":"https://mintcdn.com/choicely/sjnbmnzP-IZNUYYg/favicon.png?fit=max\u0026auto=format\u0026n=sjnbmnzP-IZNUYYg\u0026q=85\u0026s=5cad0a4d107bd6ed6cca8c3aafd308df","navbar":{"links":[{"href":"mailto:support@choicely.com","label":"Support"}],"primary":{"type":"button","label":"Choicely Studio","href":"https://studio.choicely.com"}},"footer":{"socials":{"facebook":"https://www.facebook.com/Choicelyapp","instagram":"https://www.instagram.com/choicelyapp","linkedin":"https://linkedin.com/company/choicely"}},"seo":{"metatags":{"canonical":"https://docs.choicely.com"}},"integrations":{"gtm":{"tagId":"GTM-5Z7F93L"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Choicely Studio","icon":"rocket","href":"https://studio.choicely.com"},{"anchor":"Website","icon":"globe","href":"https://www.choicely.com"},{"anchor":"Github Demo Project","icon":"github","href":"https://github.com/choicely/choicely-sdk-demo"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"choicely","hasAudioNarration":false,"actualSubdomain":"choicely","customDomains":["docs.choicely.com"],"gitSource":{"type":"github","owner":"choicely","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":false,"edits":false},"entitlements":{},"buildId":"6ae9410e98c84ae8099a39c8:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"SDK","count":19},{"language":"default","tag":"API Reference","count":14},{"language":"default","tag":"Resources","count":14},{"language":"default","tag":"Android","count":7},{"language":"default","tag":"iOS","count":6},{"language":"default","tag":"Advanced","count":5},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"React Native","count":3},{"language":"default","tag":"Gemini CLI","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#topbar-cta-button span.bg-primary-dark{background-color:#1a1a1a}.dark #topbar-cta-button span.bg-primary-dark{background-color:white}.dark #topbar-cta-button span.text-white{color:black}.dark #topbar-cta-button svg{color:black}"}],"page":{"pagePath":"api-reference/quickstart","slug":"/api-reference/quickstart","pageMetadata":{"title":"Quickstart","description":"Set up your API key, configure requests, and call your first endpoint","icon":"rocket","href":"/api-reference/quickstart"},"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: \"Set up your API key, configure requests, and call your first endpoint\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This guide walks you through using the Choicely Developer API. By following these steps, you’ll set up your API key, configure your requests, and interact with the various API endpoints to integrate seamlessly with the platform.`}),`\n`,_jsx(Heading,{level:`2`,id:`step-1-generate-your-developer-api-key`,children:`Step 1: Generate your Developer API key`}),`\n`,_jsx(_components.p,{children:`To begin using the Developer API, generate an API key with the necessary permissions:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Go to your account’s `,_jsx(_components.strong,{children:`Manage Account`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`In `,_jsx(_components.strong,{children:`Linked accounts`}),`, select `,_jsx(_components.strong,{children:`Developer API`}),` and create your API key.`]}),`\n`,_jsx(_components.li,{children:`Choose the permissions your API key should have based on your integration needs.`}),`\n`,_jsx(_components.li,{children:`Copy the generated API key and store it securely — you’ll need it for configuring requests.`}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Store your API key securely and never expose it in client-side code. Treat it like a password.`})}),`\n`,_jsx(Heading,{level:`2`,id:`step-2-configure-your-request-with-the-api-key`,children:`Step 2: Configure your request with the API key`}),`\n`,_jsx(_components.p,{children:`Use your API key as a Bearer token in the request header to authenticate your calls:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`Authorization:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`YOUR_API_KE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Y`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`This header ensures that each API request is authorized and processed securely. See `,_jsx(_components.a,{href:`/api-reference/authentication`,children:`Authentication`}),` for details.`]}),`\n`,_jsx(Heading,{level:`2`,id:`step-3-browse-the-documentation`,children:`Step 3: Browse the documentation`}),`\n`,_jsxs(_components.p,{children:[`Explore the `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`resource pages`}),` to find the available endpoints. Each endpoint includes:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`A description of the endpoint’s functionality`}),`\n`,_jsx(_components.li,{children:`Required headers, parameters, and permissions`}),`\n`,_jsx(_components.li,{children:`Sample payloads for reference`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`step-4-choose-your-endpoint-and-http-method`,children:`Step 4: Choose your endpoint and HTTP method`}),`\n`,_jsx(_components.p,{children:`Find the endpoint you want to use based on your integration requirements:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Available endpoints:`}),` `,_jsx(_components.code,{children:`/apps`}),`, `,_jsx(_components.code,{children:`/articles`}),`, `,_jsx(_components.code,{children:`/contests`}),`, and others.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`HTTP methods:`}),` Identify the method required for each endpoint, such as `,_jsx(_components.code,{children:`GET`}),`, `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`PATCH`}),`, etc.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`For example:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`POST`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` /apps`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`GET`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` /apps/\u003capp_key>`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`PATCH`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` /apps/\u003capp_key>`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`step-5-experiment-with-sample-payloads`,children:`Step 5: Experiment with sample payloads`}),`\n`,_jsx(_components.p,{children:`Each resource page provides a sample payload to help you format your data:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Request body:`}),` Use the sample payload as a guide for structuring your request.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Customization:`}),` Adjust fields within the payload to meet your requirements.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Testing:`}),` Try sending requests with sample payloads in Postman or any HTTP client.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Now you’re ready to start integrating with the Choicely Developer API. For any questions, refer to the resource pages or reach out to `,_jsx(_components.a,{href:`mailto:support@choicely.com`,children:`support@choicely.com`}),` for further assistance.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Quickstart","description":"Set up your API key, configure requests, and call your first endpoint","icon":"rocket","href":"/api-reference/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Step 1: Generate your Developer API key","slug":"step-1-generate-your-developer-api-key","depth":2,"children":[]},{"title":"Step 2: Configure your request with the API key","slug":"step-2-configure-your-request-with-the-api-key","depth":2,"children":[]},{"title":"Step 3: Browse the documentation","slug":"step-3-browse-the-documentation","depth":2,"children":[]},{"title":"Step 4: Choose your endpoint and HTTP method","slug":"step-4-choose-your-endpoint-and-http-method","depth":2,"children":[]},{"title":"Step 5: Experiment with sample payloads","slug":"step-5-experiment-with-sample-payloads","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"choicely","siteName":"Choicely Mobile SDK","title":"Quickstart - Choicely Mobile SDK","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-08T11:00:58.737Z","originalFileLocation":"api-reference/quickstart.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=\"Set up your API key, configure requests, and call your first endpoint\">\u003cmeta data-mint-head name=\"application-name\" content=\"Choicely Mobile SDK\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - Choicely Mobile SDK\">\u003cmeta data-mint-head property=\"og:description\" content=\"Set up your API key, configure requests, and call your first endpoint\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Choicely Mobile SDK\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.choicely.com/api-reference/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://choicely.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Quickstart\u0026amp;description=Set+up+your+API+key%2C+configure+requests%2C+and+call+your+first+endpoint\u0026amp;theme=fe40a4e0dd207c374d7fb322\u0026amp;signature=caea954c441de8139e1d85429574d6a5af74cf48d99e1c2ecd5bacd145a1d06f\">\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=\"Quickstart - Choicely Mobile SDK\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Set up your API key, configure requests, and call your first endpoint\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://choicely.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Quickstart\u0026amp;description=Set+up+your+API+key%2C+configure+requests%2C+and+call+your+first+endpoint\u0026amp;theme=fe40a4e0dd207c374d7fb322\u0026amp;signature=caea954c441de8139e1d85429574d6a5af74cf48d99e1c2ecd5bacd145a1d06f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/choicely/ph1AGDmIlun5f_8C/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Choicely Mobile SDK\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00D68F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.choicely.com/api-reference/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.choicely.com/#organization\",\"name\":\"Choicely Mobile SDK\",\"url\":\"https://docs.choicely.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/choicely/5ATW2QVKA6uvu958/logo/choicely-logo.png?fit=max\u0026auto=format\u0026n=5ATW2QVKA6uvu958\u0026q=85\u0026s=486af2e5a68e76f999f2a74137a537af\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.choicely.com#website\",\"name\":\"Choicely Mobile SDK\",\"url\":\"https://docs.choicely.com\",\"publisher\":{\"@id\":\"https://docs.choicely.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.choicely.com/api-reference/quickstart#webpage\",\"url\":\"https://docs.choicely.com/api-reference/quickstart\",\"name\":\"Quickstart\",\"description\":\"Set up your API key, configure requests, and call your first endpoint\",\"dateModified\":\"2026-07-08T11:00:58.737Z\",\"isPartOf\":{\"@id\":\"https://docs.choicely.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.choicely.com/api-reference/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.choicely.com/api-reference/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.choicely.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.choicely.com/api-reference/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.choicely.com/api-reference/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"description\":\"Set up your API key, configure requests, and call your first endpoint\",\"url\":\"https://docs.choicely.com/api-reference/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.choicely.com/api-reference/quickstart#webpage\"},\"dateModified\":\"2026-07-08T11:00:58.737Z\",\"publisher\":{\"@id\":\"https://docs.choicely.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.choicely.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Choicely Mobile SDK\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Choicely Mobile SDK\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/quickstart.md","siteName":"Choicely Mobile SDK","nav":{"global":{"anchors":[{"anchor":"Choicely Studio","icon":"rocket","href":"https://studio.choicely.com"},{"anchor":"Website","icon":"globe","href":"https://www.choicely.com"},{"anchor":"Github Demo Project","icon":"github","href":"https://github.com/choicely/choicely-sdk-demo"}]},"tabs":[{"tab":"SDK","pages":[{"title":"SDK","href":"/android/quick-start"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","description":"Integrate with Choicely using the Developer REST API","icon":"book-open","href":"/api-reference/introduction"},{"title":"Quickstart","icon":"rocket","href":"/api-reference/quickstart"},{"title":"Authentication","description":"Authenticate Developer API requests with a Bearer token","icon":"key","href":"/api-reference/authentication"}]},{"group":"Resources","pages":[{"title":"App","icon":"mobile-screen","href":"/api-reference/app"},{"title":"Article","icon":"newspaper","href":"/api-reference/article"},{"title":"Contest","icon":"trophy","href":"/api-reference/contest"},{"title":"Feed","icon":"rss","href":"/api-reference/feed"},{"title":"File","icon":"file","href":"/api-reference/file"},{"title":"Image","icon":"image","href":"/api-reference/image"},{"title":"Purchase","icon":"credit-card","href":"/api-reference/purchase"},{"title":"Schedule","icon":"calendar","href":"/api-reference/schedule"},{"title":"Shop","icon":"store","href":"/api-reference/shop"},{"title":"Survey","icon":"square-poll-vertical","href":"/api-reference/survey"},{"title":"Vote count","icon":"check-to-slot","href":"/api-reference/vote-count"}]}]},{"tab":"Gemini CLI","pages":[{"title":"Gemini CLI","href":"/AI/gemini-cli-playbook"}]}]},"basePath":"","title":"Quickstart - Choicely Mobile SDK","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}