{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hoppier Docs","description":"Create Hoppier reward programs and add people to them with the REST API, receive card.claimed webhooks, use Zapier, and connect Claude or ChatGPT to Hoppier.","colors":{"primary":"#CC2828","light":"#FF8585","dark":"#E84040"},"logo":{"light":"https://mintcdn.com/hoppier/Y8GKJ5Y2QYvBgc3e/logo/light.svg?fit=max\u0026auto=format\u0026n=Y8GKJ5Y2QYvBgc3e\u0026q=85\u0026s=9abe1aae9084dfe98a05455cc48499d5","dark":"https://mintcdn.com/hoppier/Y8GKJ5Y2QYvBgc3e/logo/dark.svg?fit=max\u0026auto=format\u0026n=Y8GKJ5Y2QYvBgc3e\u0026q=85\u0026s=8fd35bd63fed17dcd8a278a94b4a3bf5","href":"https://www.hoppier.com"},"favicon":"https://mintcdn.com/hoppier/Y8GKJ5Y2QYvBgc3e/favicon.png?fit=max\u0026auto=format\u0026n=Y8GKJ5Y2QYvBgc3e\u0026q=85\u0026s=86db29278b8afca792c07e3cab4174a2","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["curl","javascript","python"]}},"navbar":{"links":[{"href":"https://help.hoppier.com","label":"Help center"}],"primary":{"type":"button","label":"Open Hoppier","href":"https://app.hoppier.com"}},"footer":{"links":[{"header":"Hoppier","items":[{"label":"hoppier.com","href":"https://www.hoppier.com"},{"label":"Dashboard","href":"https://app.hoppier.com"},{"label":"Help center","href":"https://help.hoppier.com"}]},{"header":"Integrations","items":[{"label":"Zapier","href":"https://zapier.com/apps/hoppier/integrations"},{"label":"Hoppier MCP","href":"https://www.hoppier.com/mcp"}]}]},"seo":{"metatags":{"og:site_name":"Hoppier Docs","canonical":"https://docs.hoppier.com"},"indexing":"navigable"},"contextual":{"options":["copy","view","download-spec","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hoppier","hasAudioNarration":false,"actualSubdomain":"hoppier","customDomains":["docs.hoppier.com"],"gitSource":{"type":"github","owner":"desknibbles","repo":"docs.hoppier.com","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ada7cd39116d87a9a191de8"},"chroma":{"latestBuiltDeploymentHistoryId":"6ada7d1b9116d87a9a192493","collectionId":"06cf876b-5a43-4ce1-a696-b66a5300181f","liveDeploymentHistoryId":"6ada7d1b9116d87a9a192493","schemaVersion":"v3"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adf6efd97503f50adc6862c","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API reference","count":11},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"AI assistants","count":5},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Programs","count":3},{"language":"default","tag":"Hoppier for Claude and ChatGPT","count":2},{"language":"default","tag":"Tools","count":2},{"language":"default","tag":"What's next","count":2},{"language":"default","tag":"Concepts","count":2},{"language":"default","tag":"Integrate","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/addresses/list","slug":"/api-reference/addresses/list","pageMetadata":{"title":"List addresses","description":"Returns your company's saved addresses, oldest first. The one marked `isDefault` is the address [`POST /programs`](/api-reference/programs/create) uses when you leave out `addressId`.\n\nThe key's owner must be an admin of the company.\n","deprecated":null,"version":null,"sidebarTitle":"List addresses","openapi":"/openapi.yaml get /addresses","href":"/api-reference/addresses/list","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Returns your company’s saved addresses, oldest first. The one marked \", _jsx(_components.code, {\n children: \"isDefault\"\n }), \" is the address \", _jsx(_components.a, {\n href: \"/api-reference/programs/create\",\n children: _jsx(_components.code, {\n children: \"POST /programs\"\n })\n }), \" uses when you leave out \", _jsx(_components.code, {\n children: \"addressId\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"The key’s owner must be an admin of the company.\"\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":"List addresses","description":"Returns your company's saved addresses, oldest first. The one marked `isDefault` is the address [`POST /programs`](/api-reference/programs/create) uses when you leave out `addressId`.\n\nThe key's owner must be an admin of the company.\n","deprecated":null,"version":null,"sidebarTitle":"List addresses","openapi":"/openapi.yaml get /addresses","href":"/api-reference/addresses/list","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listAddresses","tags":["Addresses"],"summary":"List addresses","description":"Returns your company's saved addresses, oldest first. The one marked `isDefault` is the address [`POST /programs`](/api-reference/programs/create) uses when you leave out `addressId`.\n\nThe key's owner must be an admin of the company.\n","x-mint":{"href":"/api-reference/addresses/list","metadata":{"sidebarTitle":"List addresses"}},"responses":{"200":"662f2978-e44c-40e3-acd0-0e214cc390bf","401":"0ac4baa6-d035-4a4d-916a-322ceb94d2ad","403":"8c88cc0d-42fc-486e-a70b-9bb6da3f7bed","429":"2ed927a0-4660-4b9b-b9c6-35bdc3930868","500":"554ae4f2-4010-42dc-b474-2924b1946b9d"},"method":"get","type":"path","servers":["f4ad5d70-ac67-45bb-b9e3-2551251b7283"],"security":["1e5229cc-14c0-4a85-93f4-ee1edeff168d"],"path":"/addresses","baseUrlOptions":["https://app.hoppier.com/api/v1"],"title":"List addresses","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"662f2978-e44c-40e3-acd0-0e214cc390bf":{"description":"The company's addresses. An empty list if it has none.","content":{"application/json":{"schema":{"type":"object","required":["addresses"],"properties":{"addresses":{"type":"array","items":{"type":"object","description":"One of your company's saved addresses.","required":["id","object","line1","city","state","postalCode","country","isDefault"],"properties":{"id":{"type":"string","description":"The address's id. Starts with `ad_`.","examples":["ad_7Ym2p0Lx3Q"],"isRequired":true,"uniqueKey":"addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","const":"address","isRequired":true,"uniqueKey":"addresses.items.[INDEX].object","typeLabel":"string"},"line1":{"type":"string","examples":["350 Fifth Avenue"],"isRequired":true,"uniqueKey":"addresses.items.[INDEX].line1","typeLabel":"string"},"city":{"type":"string","examples":["New York"],"isRequired":true,"uniqueKey":"addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","description":"The state or territory's name.","examples":["New York"],"isRequired":true,"uniqueKey":"addresses.items.[INDEX].state","typeLabel":"string"},"postalCode":{"type":"string","examples":["10118"],"isRequired":true,"uniqueKey":"addresses.items.[INDEX].postalCode","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code.","examples":["US"],"isRequired":true,"uniqueKey":"addresses.items.[INDEX].country","typeLabel":"string"},"isDefault":{"type":"boolean","description":"`true` for the address new programs use when you leave out `addressId`: your company's oldest saved address.\n","isRequired":true,"uniqueKey":"addresses.items.[INDEX].isDefault","typeLabel":"boolean"},"line2":{"type":"string","description":"Left out when the address has no second line.","examples":["Floor 20"],"uniqueKey":"addresses.items.[INDEX].line2","typeLabel":"string"}},"uniqueKey":"addresses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"addresses","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"addresses":[{"id":"ad_7Ym2p0Lx3Q","object":"address","line1":"350 Fifth Avenue","line2":"Floor 20","city":"New York","state":"New York","postalCode":"10118","country":"US","isDefault":true}]},"examples":{"Example":{"title":"Example","value":{"addresses":[{"id":"ad_7Ym2p0Lx3Q","object":"address","line1":"350 Fifth Avenue","line2":"Floor 20","city":"New York","state":"New York","postalCode":"10118","country":"US","isDefault":true}]}}},"exampleType":"examples"}},"exampleType":"examples"},"0ac4baa6-d035-4a4d-916a-322ceb94d2ad":{"description":"`unauthorized`: the API key is missing or malformed, or it's wrong, unknown or switched off.\n","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"A machine-readable code, such as `unauthorized` or `program_not_found`. Act on it and the HTTP status. New codes can appear, so handle one you don't recognise by its status. [Every code](/guides/errors-and-rate-limits#error-codes).\n","examples":["program_not_found"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, in plain words. Don't parse it; it can change.","examples":["Program not found."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameter":{"type":"string","description":"On some `invalid_request` errors, the field that was refused.","examples":["email"],"uniqueKey":"parameter","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingKey":{"title":"missingKey","value":{"error":"unauthorized","message":"API key is missing. Send it as \"Authorization: Bearer \u003ckey>\"."}},"invalidKey":{"title":"invalidKey","value":{"error":"unauthorized","message":"API key is not valid."}},"inactiveKey":{"title":"inactiveKey","value":{"error":"unauthorized","message":"API key is inactive."}}},"exampleType":"examples"}},"exampleType":"examples"},"8c88cc0d-42fc-486e-a70b-9bb6da3f7bed":{"description":"`insufficient_permission`: the key's owner isn't an admin of the company.\n","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"A machine-readable code, such as `unauthorized` or `program_not_found`. Act on it and the HTTP status. New codes can appear, so handle one you don't recognise by its status. [Every code](/guides/errors-and-rate-limits#error-codes).\n","examples":["program_not_found"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, in plain words. Don't parse it; it can change.","examples":["Program not found."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameter":{"type":"string","description":"On some `invalid_request` errors, the field that was refused.","examples":["email"],"uniqueKey":"parameter","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"insufficient_permission","message":"This API key's user is not an admin of this account."},"examples":{"Example":{"title":"Example","value":{"error":"insufficient_permission","message":"This API key's user is not an admin of this account."}}},"exampleType":"examples"}},"exampleType":"examples"},"2ed927a0-4660-4b9b-b9c6-35bdc3930868":{"description":"`rate_limited`: too many requests. Wait the number of seconds in `Retry-After`, then retry. See [Errors and rate limits](/guides/errors-and-rate-limits#rate-limits).\n","headers":{"Retry-After":{"description":"Whole seconds to wait before retrying.","schema":{"type":"string"},"example":"30"},"X-RateLimit-Remaining":{"description":"Per-address limit only. Requests left in the current 10-second window, so `0` on a 429.","schema":{"type":"string"},"example":"0"},"X-RateLimit-Reset":{"description":"Per-address limit only. When the window refills, as a Unix timestamp in seconds.","schema":{"type":"string"},"example":"1793491210"}},"content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"A machine-readable code, such as `unauthorized` or `program_not_found`. Act on it and the HTTP status. New codes can appear, so handle one you don't recognise by its status. [Every code](/guides/errors-and-rate-limits#error-codes).\n","examples":["program_not_found"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, in plain words. Don't parse it; it can change.","examples":["Program not found."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameter":{"type":"string","description":"On some `invalid_request` errors, the field that was refused.","examples":["email"],"uniqueKey":"parameter","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"perAccount":{"title":"perAccount","value":{"error":"rate_limited","message":"Too many requests for this account. Retry after the number of seconds in Retry-After."}},"perAddress":{"title":"perAddress","value":{"error":"rate_limited","message":"Too Many Requests"}}},"exampleType":"examples"}},"exampleType":"examples"},"554ae4f2-4010-42dc-b474-2924b1946b9d":{"description":"`internal_error`: something went wrong on Hoppier's side. The message never contains internal details. Retry with backoff; if it keeps happening, email support@hoppier.com.\n","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"A machine-readable code, such as `unauthorized` or `program_not_found`. Act on it and the HTTP status. New codes can appear, so handle one you don't recognise by its status. [Every code](/guides/errors-and-rate-limits#error-codes).\n","examples":["program_not_found"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, in plain words. Don't parse it; it can change.","examples":["Program not found."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameter":{"type":"string","description":"On some `invalid_request` errors, the field that was refused.","examples":["email"],"uniqueKey":"parameter","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"internal_error","message":"An unexpected error occurred."},"examples":{"Example":{"title":"Example","value":{"error":"internal_error","message":"An unexpected error occurred."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"1e5229cc-14c0-4a85-93f4-ee1edeff168d":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"hk_live.\u003cprefix>.\u003csecret>","description":"Send your key in the `Authorization` header: `Authorization: Bearer hk_live.…`. The word `Bearer` is case-sensitive.\n\nKeys are shown once. Treat them like passwords and never put one in code that runs in a browser or an app.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"f4ad5d70-ac67-45bb-b9e3-2551251b7283":{"url":"https://app.hoppier.com/api/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"hk_live.\u003cprefix>.\u003csecret>","description":"Send your key in the `Authorization` header: `Authorization: Bearer hk_live.…`. The word `Bearer` is case-sensitive.\n\nKeys are shown once. Treat them like passwords and never put one in code that runs in a browser or an app.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send your key in the `Authorization` header: `Authorization: Bearer hk_live.…`. The word `Bearer` is case-sensitive.\n\nKeys are shown once. Treat them like passwords and never put one in code that runs in a browser or an app.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"hoppier","siteName":"Hoppier Docs","title":"List addresses - Hoppier Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T15:17:50.665Z","originalFileLocation":"api-reference/addresses/list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns your company\u0026#x27;s saved addresses, oldest first. The one marked isDefault is the address POST /programs uses when you leave out addressId. The key\u0026#x27;s owner must be an admin of the company.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hoppier Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hoppier/kZ3B37Q8hX9ddWTj/_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/hoppier/kZ3B37Q8hX9ddWTj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hoppier/kZ3B37Q8hX9ddWTj/_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/hoppier/kZ3B37Q8hX9ddWTj/_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/hoppier/kZ3B37Q8hX9ddWTj/_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/hoppier/kZ3B37Q8hX9ddWTj/_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/hoppier/kZ3B37Q8hX9ddWTj/_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/hoppier/kZ3B37Q8hX9ddWTj/_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/hoppier/kZ3B37Q8hX9ddWTj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List addresses - Hoppier Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns your company\u0026#x27;s saved addresses, oldest first. The one marked isDefault is the address POST /programs uses when you leave out addressId. The key\u0026#x27;s owner must be an admin of the company.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hoppier Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hoppier.com/api-reference/addresses/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hoppier.mintlify.app/_mintlify/api/og/v2?division=Addresses\u0026amp;title=List+addresses\u0026amp;description=Returns+your+company%27s+saved+addresses%2C+oldest+first.+The+one+marked+%60isDefault%60+is+the+address+%5B%60POST+%2Fprograms%60%5D%28%2Fapi-reference%2Fprograms%2Fcreate%29+uses+when+you\u0026amp;theme=78815a23ccd92b32a1f628e7\u0026amp;signature=e3f260408980732a5ad505877a704a7219e762e185f1677a8475dd958e055e3d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List addresses - Hoppier Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns your company\u0026#x27;s saved addresses, oldest first. The one marked isDefault is the address POST /programs uses when you leave out addressId. The key\u0026#x27;s owner must be an admin of the company.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hoppier.mintlify.app/_mintlify/api/og/v2?division=Addresses\u0026amp;title=List+addresses\u0026amp;description=Returns+your+company%27s+saved+addresses%2C+oldest+first.+The+one+marked+%60isDefault%60+is+the+address+%5B%60POST+%2Fprograms%60%5D%28%2Fapi-reference%2Fprograms%2Fcreate%29+uses+when+you\u0026amp;theme=78815a23ccd92b32a1f628e7\u0026amp;signature=e3f260408980732a5ad505877a704a7219e762e185f1677a8475dd958e055e3d\">\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/hoppier/kZ3B37Q8hX9ddWTj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hoppier Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#CC2828\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hoppier.com/api-reference/addresses/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/addresses/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hoppier.com/#organization\",\"name\":\"Hoppier Docs\",\"url\":\"https://docs.hoppier.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hoppier/Y8GKJ5Y2QYvBgc3e/logo/light.svg?fit=max\u0026auto=format\u0026n=Y8GKJ5Y2QYvBgc3e\u0026q=85\u0026s=9abe1aae9084dfe98a05455cc48499d5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hoppier.com#website\",\"name\":\"Hoppier Docs\",\"url\":\"https://docs.hoppier.com\",\"publisher\":{\"@id\":\"https://docs.hoppier.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hoppier.com/api-reference/addresses/list#webpage\",\"url\":\"https://docs.hoppier.com/api-reference/addresses/list\",\"name\":\"List addresses\",\"description\":\"Returns your company's saved addresses, oldest first. The one marked isDefault is the address POST /programs uses when you leave out addressId. The key's owner must be an admin of the company.\",\"dateModified\":\"2026-10-26T15:17:50.665Z\",\"isPartOf\":{\"@id\":\"https://docs.hoppier.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hoppier.com/api-reference/addresses/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hoppier.com/api-reference/addresses/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Hoppier Docs\",\"item\":\"https://docs.hoppier.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List addresses\",\"item\":\"https://docs.hoppier.com/api-reference/addresses/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hoppier.com/api-reference/addresses/list#apireference\",\"headline\":\"List addresses\",\"name\":\"List addresses\",\"description\":\"Returns your company's saved addresses, oldest first. The one marked isDefault is the address POST /programs uses when you leave out addressId. The key's owner must be an admin of the company.\",\"url\":\"https://docs.hoppier.com/api-reference/addresses/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hoppier.com/api-reference/addresses/list#webpage\"},\"dateModified\":\"2026-10-26T15:17:50.665Z\",\"publisher\":{\"@id\":\"https://docs.hoppier.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hoppier.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hoppier Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hoppier Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Overview","tag":"Beta","href":"/api-reference/overview"}]},{"group":"Account","pages":[{"title":"Check your API key","description":"Confirms that a key works and tells you which admin and company it belongs to.\n\nEvery key Hoppier accepts gets a 200 here, whatever its owner's role. Use it as a connection test, not as a permission check.\n","deprecated":null,"version":null,"sidebarTitle":"Check your key","openapi":"/openapi.yaml get /validate","href":"/api-reference/validate"}]},{"group":"Addresses","pages":[{"title":"List addresses","deprecated":null,"version":null,"sidebarTitle":"List addresses","openapi":"/openapi.yaml get /addresses","href":"/api-reference/addresses/list"},{"title":"Save an address","description":"Saves a US address for your company and returns it, for new programs to use as their `addressId`. A prepaid Visa card program's address is the billing address on its cards.\n\nThe key's owner must be an admin who is allowed to create programs.\n","deprecated":null,"version":null,"sidebarTitle":"Save an address","openapi":"/openapi.yaml post /addresses","href":"/api-reference/addresses/create"}]},{"group":"Merchants","pages":[{"title":"Look up merchants","deprecated":null,"version":null,"sidebarTitle":"Look up merchants","openapi":"/openapi.yaml get /merchants","href":"/api-reference/merchants/list"}]},{"group":"Programs","pages":[{"title":"List programs","deprecated":null,"version":null,"sidebarTitle":"List programs","openapi":"/openapi.yaml get /programs","href":"/api-reference/programs/list"},{"title":"Get a program","deprecated":null,"version":null,"sidebarTitle":"Get a program","openapi":"/openapi.yaml get /programs/{program}","href":"/api-reference/programs/get"},{"title":"Create a program","deprecated":null,"version":null,"sidebarTitle":"Create a program","openapi":"/openapi.yaml post /programs","href":"/api-reference/programs/create"}]},{"group":"Participants","pages":[{"title":"Add a participant","deprecated":null,"version":null,"sidebarTitle":"Add a participant","openapi":"/openapi.yaml post /participants","href":"/api-reference/participants/add"},{"title":"List participants","deprecated":null,"version":null,"sidebarTitle":"List participants","openapi":"/openapi.yaml get /participants","href":"/api-reference/participants/list"}]},{"group":"Webhooks","pages":[{"title":"card.claimed","openapi":"openapi.yaml webhook card.claimed","href":"/api-reference/webhooks/card-claimed"}]}]},{"tab":"AI assistants","pages":[{"title":"AI assistants","href":"/ai-assistants/overview"}]}]},"title":"List addresses - Hoppier Docs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}