{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Paylead","colors":{"primary":"#0465ff","light":"#4d7cff","dark":"#0146b8"},"logo":{"light":"https://mintcdn.com/paylead-04d0cbf1/5Du5nX6Yx2FNkQMU/logo/paylead-light.svg?fit=max\u0026auto=format\u0026n=5Du5nX6Yx2FNkQMU\u0026q=85\u0026s=ccd3972668e08f641390b653caf833dc","dark":"https://mintcdn.com/paylead-04d0cbf1/5Du5nX6Yx2FNkQMU/logo/paylead-dark.svg?fit=max\u0026auto=format\u0026n=5Du5nX6Yx2FNkQMU\u0026q=85\u0026s=289a65fff3ce15c8cbc8e9f292d1fdfa","href":"https://paylead.fr"},"favicon":"https://mintcdn.com/paylead-04d0cbf1/PhlJSwO-Cg3kzZM3/logo/favicon.png?fit=max\u0026auto=format\u0026n=PhlJSwO-Cg3kzZM3\u0026q=85\u0026s=82b4008639f970a617d69aff89f89eb3","api":{"playground":{"proxy":true},"examples":{"prefill":true}},"appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"light":"#ffffff","dark":"#1c212f"}},"navbar":{"primary":{"type":"button","label":"Request a demo","href":"https://paylead.fr"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/paylead","website":"https://paylead.fr"}},"seo":{"metatags":{"canonical":"https://docs.paylead.fr"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["download-pdf","download-spec"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paylead-04d0cbf1","hasAudioNarration":false,"actualSubdomain":"paylead-04d0cbf1","customDomains":["docs.paylead.fr"],"gitSource":{"type":"gitlab","owner":"paylead/projects","repo":"documentation","projectId":82335499,"deployBranch":"main","contentDirectory":"src","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afc1781951f253784cc2e81","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Program","count":88},{"language":"default","tag":"API","count":33},{"language":"default","tag":"Perks","count":27},{"language":"default","tag":"Documentation","count":25},{"language":"default","tag":"Shift","count":22},{"language":"default","tag":"Consumers","count":18},{"language":"default","tag":"Integration","count":8},{"language":"default","tag":"WebApp","count":8},{"language":"default","tag":"Catalog","count":6},{"language":"default","tag":"Reference \u0026 help","count":6}],"searchSettings":{"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@paylead.fr"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"program/api/legacy/1.1.10/connector/brands/get-brands","slug":"/program/api/legacy/1.1.10/connector/brands/get-brands","pageMetadata":{"title":"Get Brands","description":"List of all brands that are allowed to be published on your program.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/brands","href":"/program/api/legacy/1.1.10/connector/brands/get-brands","autogeneratedByOpenApi":true,"hidden":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"List of all brands that are allowed to be published on your program.\"\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 Brands","description":"List of all brands that are allowed to be published on your program.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/brands","href":"/program/api/legacy/1.1.10/connector/brands/get-brands","autogeneratedByOpenApi":true,"hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"List of all brands that are allowed to be published on your program.\n","parameters":["6bfc19ee-3854-40a1-8c55-9a5ff18e89cc","486707d6-7cc2-40a2-b586-3ba7e8438774","62703006-74a5-40ee-827d-a7728ff4b2cc","029ff8b9-5b89-41f5-af88-0ac0a3279e6c","732a9c2a-5e32-45e6-b942-a0fa5e02bad9","46d8cbee-3f0d-419a-a471-f2a9ea7c99f1","62b5745a-d4e4-43fe-ba6d-5b1b3d3622b1","4b7b4684-c98c-4540-a2af-2edd6fbe113f","71e21036-d48c-446c-9037-c62407170a5f","2f1c0697-58d3-4a90-922e-65c54c7becf5"],"responses":{"200":"6b27f758-92af-4da6-a581-2ae2abe178d8","400":"17c43001-c9fa-4880-9a86-a2eef976360b","401":"555b9667-85df-4e1f-a12d-87cef5d59a9b","403":"1f7ac046-77f2-4def-aedd-1d06494c0732","404":"7a7cd31c-14fe-41b0-aac3-62b3b7e3d8b5","405":"28356f06-e1fc-489c-bab9-8e34f0c24abd","422":"1e726dde-a77b-4cb0-9de2-acdc6dc2e746"},"summary":"Get Brands","tags":["Brands"],"method":"get","type":"path","servers":["913c3bdb-0f09-40d8-9f67-be3271f4c50a"],"security":["602af05e-f31f-4764-8d6c-f870d6d701a9"],"path":"/connectors/brands","baseUrlOptions":["https://api.sandbox.paylead.tech"],"title":"Get Brands","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"6bfc19ee-3854-40a1-8c55-9a5ff18e89cc":{"description":"Filter by id\n\nUnique ID of the object.","example":"e2c32b4b-de61-459b-accf-a75f76247946","in":"query","name":"id","schema":{"format":"uuid","type":"string","description":"Filter by id\n\nUnique ID of the object.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"486707d6-7cc2-40a2-b586-3ba7e8438774":{"description":"Filter by name\n\nName of the object","in":"query","name":"name","schema":{"type":"string","description":"Filter by name\n\nName of the object","uniqueKey":"","typeLabel":"string"}},"62703006-74a5-40ee-827d-a7728ff4b2cc":{"description":"Filter by offer__public","in":"query","name":"offer__public","schema":{"type":"boolean","description":"Filter by offer__public","uniqueKey":"","typeLabel":"boolean"}},"029ff8b9-5b89-41f5-af88-0ac0a3279e6c":{"description":"Filter by offer__source_transaction","in":"query","name":"offer__source_transaction","schema":{"type":"boolean","description":"Filter by offer__source_transaction","uniqueKey":"","typeLabel":"boolean"}},"732a9c2a-5e32-45e6-b942-a0fa5e02bad9":{"description":"Type of the offer","in":"query","name":"offer__type","schema":{"enum":["CASHBACK","UNIQUE_COUPON","GENERIC_COUPON","VOUCHER","AFFILIATION","LBS_CASHBACK"],"type":"string","description":"Type of the offer","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"46d8cbee-3f0d-419a-a471-f2a9ea7c99f1":{"description":"the page number","in":"query","name":"page","required":false,"schema":{"minimum":1,"type":"integer","isRequired":false,"description":"the page number","uniqueKey":"","typeLabel":"integer"}},"62b5745a-d4e4-43fe-ba6d-5b1b3d3622b1":{"description":"the number of elements per page","in":"query","name":"per_page","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","isRequired":false,"description":"the number of elements per page","uniqueKey":"","typeLabel":"integer"}},"4b7b4684-c98c-4540-a2af-2edd6fbe113f":{"description":"Sort by given attribute","in":"query","name":"sort","schema":{"enum":["name","id","universe__name","universe__id","offer__type","offer__source_transaction","-name","-id","-universe__name","-universe__id","-offer__type","-offer__source_transaction"],"type":"string","description":"Sort by given attribute","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"71e21036-d48c-446c-9037-c62407170a5f":{"description":"Filter by universe__id","in":"query","name":"universe__id","schema":{"format":"uuid","type":"string","description":"Filter by universe__id","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"2f1c0697-58d3-4a90-922e-65c54c7becf5":{"description":"Filter by universe__name","in":"query","name":"universe__name","schema":{"type":"string","description":"Filter by universe__name","uniqueKey":"","typeLabel":"string"}}},"responses":{"6b27f758-92af-4da6-a581-2ae2abe178d8":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"name":{"description":"Name of the object","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"id":{"description":"Unique ID of the object.","example":"e2c32b4b-de61-459b-accf-a75f76247946","format":"uuid","readOnly":true,"type":"string","uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"logo":{"properties":{"path":{"description":"Path of the logo.","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].logo.path","typeLabel":"string"},"content_type":{"description":"Content type of the logo.","type":"string","uniqueKey":"\\items.items.[INDEX].logo.content_type","typeLabel":"string"},"created_at":{"description":"Object creation datetime","example":"2019-01-31T15:16:15.523309+00:00","format":"date-time","type":"string","uniqueKey":"\\items.items.[INDEX].logo.created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Unique ID of the object.","example":"e2c32b4b-de61-459b-accf-a75f76247946","format":"uuid","type":"string","uniqueKey":"\\items.items.[INDEX].logo.id","typeLabel":"string\u003cuuid>"},"links":{"properties":{"download":{"description":"The link to download the data.","format":"url","type":"string","uniqueKey":"\\items.items.[INDEX].logo.links.download","typeLabel":"string\u003curl>"},"preview":{"description":"The link to preview the data.","format":"url","type":"string","uniqueKey":"\\items.items.[INDEX].logo.links.preview","typeLabel":"string\u003curl>"}},"type":"object","uniqueKey":"\\items.items.[INDEX].logo.links","typeLabel":"object"},"name":{"description":"Name of the object","uniqueKey":"\\items.items.[INDEX].logo.name","typeLabel":"any"},"owner":{"description":"Owner of the logo.","type":"string","uniqueKey":"\\items.items.[INDEX].logo.owner","typeLabel":"string"}},"required":["path"],"type":"object","uniqueKey":"\\items.items.[INDEX].logo","typeLabel":"object"},"logos":{"description":"Logos of the brand.","items":{"properties":{"illustration_usage_name":{"description":"Intended use case of the associated image.","type":"string","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].illustration_usage_name","typeLabel":"string"},"logo":{"properties":{"path":{"description":"Path of the logo.","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.path","typeLabel":"string"},"content_type":{"description":"Content type of the logo.","type":"string","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.content_type","typeLabel":"string"},"created_at":{"description":"Object creation datetime","example":"2019-01-31T15:16:15.523309+00:00","format":"date-time","type":"string","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Unique ID of the object.","example":"e2c32b4b-de61-459b-accf-a75f76247946","format":"uuid","type":"string","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.id","typeLabel":"string\u003cuuid>"},"links":{"properties":{"download":{"description":"The link to download the data.","format":"url","type":"string","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.links.download","typeLabel":"string\u003curl>"},"preview":{"description":"The link to preview the data.","format":"url","type":"string","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.links.preview","typeLabel":"string\u003curl>"}},"type":"object","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.links","typeLabel":"object"},"name":{"description":"Name of the object","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.name","typeLabel":"any"},"owner":{"description":"Owner of the logo.","type":"string","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo.owner","typeLabel":"string"}},"required":["path"],"type":"object","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX].logo","typeLabel":"object"}},"type":"object","uniqueKey":"\\items.items.[INDEX].logos.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","uniqueKey":"\\items.items.[INDEX].logos","typeLabel":"object[]"},"universes":{"description":"Universes","items":{"properties":{"id":{"description":"Unique ID of the object.","example":"e2c32b4b-de61-459b-accf-a75f76247946","format":"uuid","readOnly":true,"type":"string","uniqueKey":"\\items.items.[INDEX].universes.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"description":"Name of the object","readOnly":true,"type":"string","uniqueKey":"\\items.items.[INDEX].universes.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"description":"Name of the object","readOnly":true,"type":"null","uniqueKey":"\\items.items.[INDEX].universes.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].universes.items.[INDEX].name","typeLabel":"string | null"}},"type":"object","uniqueKey":"\\items.items.[INDEX].universes.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","uniqueKey":"\\items.items.[INDEX].universes","typeLabel":"object[]"}},"required":["name"],"type":"object","uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"\\items","typeLabel":"object[]"},"meta":{"properties":{"page":{"type":"integer","uniqueKey":"meta.page","typeLabel":"integer"},"per_page":{"type":"integer","uniqueKey":"meta.per_page","typeLabel":"integer"},"total":{"type":"integer","uniqueKey":"meta.total","typeLabel":"integer"}},"type":"object","uniqueKey":"meta","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"items":[{"name":"\u003cstring>","id":"e2c32b4b-de61-459b-accf-a75f76247946","logo":{"path":"\u003cstring>","content_type":"\u003cstring>","created_at":"2019-01-31T15:16:15.523309+00:00","id":"e2c32b4b-de61-459b-accf-a75f76247946","links":{"download":"\u003cstring>","preview":"\u003cstring>"},"name":"\u003cunknown>","owner":"\u003cstring>"},"logos":[{"illustration_usage_name":"\u003cstring>","logo":{"path":"\u003cstring>","content_type":"\u003cstring>","created_at":"2019-01-31T15:16:15.523309+00:00","id":"e2c32b4b-de61-459b-accf-a75f76247946","links":{"download":"\u003cstring>","preview":"\u003cstring>"},"name":"\u003cunknown>","owner":"\u003cstring>"}}],"universes":[{"id":"e2c32b4b-de61-459b-accf-a75f76247946","name":"\u003cstring>"}]}],"meta":{"page":123,"per_page":123,"total":123}}}},"exampleType":"generated"}},"description":"OK","links":{"get.ConnectorBrandOfferList":{"operationId":"get.ConnectorBrandOfferList","parameters":{"brand_id":"$response.body#/items/0/id"}}},"exampleType":"generated"},"17c43001-c9fa-4880-9a86-a2eef976360b":{"description":"Bad request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"555b9667-85df-4e1f-a12d-87cef5d59a9b":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1f7ac046-77f2-4def-aedd-1d06494c0732":{"description":"Not allowed to access the resource","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7a7cd31c-14fe-41b0-aac3-62b3b7e3d8b5":{"description":"Not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"28356f06-e1fc-489c-bab9-8e34f0c24abd":{"description":"Method not allowed","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1e726dde-a77b-4cb0-9de2-acdc6dc2e746":{"description":"Unprocessable Entity","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"602af05e-f31f-4764-8d6c-f870d6d701a9":{"ApiKeyAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"913c3bdb-0f09-40d8-9f67-be3271f4c50a":{"url":"https://api.sandbox.paylead.tech"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"program/api/openapi/legacy/1.1.10/connector.json"},"subdomain":"paylead-04d0cbf1","siteName":"Paylead","title":"Get Brands - Paylead","relatedPagesConfig":{"enabled":false,"limit":5,"mode":"automatic"},"contextualStarterQuestions":[{"_id":"6a58fe9e42d362a5a3c80eef","deploymentId":"6a0c4d7e2a1e1f0ed2e3fa47","questionText":"How do I retrieve all brands?","status":"active","generatedBy":"contextual","path":"program/api/legacy/1.1.10/connector/brands/get-brands","createdAt":"2026-07-16T15:54:06.170Z","updatedAt":"2026-07-16T15:54:06.170Z","__v":0},{"_id":"6a58fe9e42d362a5a3c80ef0","deploymentId":"6a0c4d7e2a1e1f0ed2e3fa47","questionText":"Which brands are allowed?","status":"active","generatedBy":"contextual","path":"program/api/legacy/1.1.10/connector/brands/get-brands","createdAt":"2026-07-16T15:54:06.170Z","updatedAt":"2026-07-16T15:54:06.170Z","__v":0},{"_id":"6a58fe9e42d362a5a3c80eee","deploymentId":"6a0c4d7e2a1e1f0ed2e3fa47","questionText":"What brands can I publish?","status":"active","generatedBy":"contextual","path":"program/api/legacy/1.1.10/connector/brands/get-brands","createdAt":"2026-07-16T15:54:06.170Z","updatedAt":"2026-07-16T15:54:06.170Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{},"searchTabScopes":[{"product":"Program","tab":"Documentation"},{"product":"Program","tab":"API"},{"product":"Program","tab":"WebApp"},{"product":"Program","tab":"Shift"},{"product":"Program","tab":"Glossary"},{"product":"Retailers","tab":"Documentation"}]},"lastModified":"2026-10-27T13:02:09.987Z","originalFileLocation":"program/api/legacy/1.1.10/connector/brands/get-brands.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=\"List of all brands that are allowed to be published on your program.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paylead\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Brands - Paylead\">\u003cmeta data-mint-head property=\"og:description\" content=\"List of all brands that are allowed to be published on your program.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paylead\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paylead-04d0cbf1.mintlify.site/_mintlify/api/og/v2?division=Brands\u0026amp;title=Get+Brands\u0026amp;description=List+of+all+brands+that+are+allowed+to+be+published+on+your+program.%0A\u0026amp;theme=6bfc0ed198bb9a7ce0d382d4\u0026amp;signature=78f5fc967896edd296c810705648fd512b658573960e486b72e02961f2d3ead6\">\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 Brands - Paylead\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List of all brands that are allowed to be published on your program.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paylead-04d0cbf1.mintlify.site/_mintlify/api/og/v2?division=Brands\u0026amp;title=Get+Brands\u0026amp;description=List+of+all+brands+that+are+allowed+to+be+published+on+your+program.%0A\u0026amp;theme=6bfc0ed198bb9a7ce0d382d4\u0026amp;signature=78f5fc967896edd296c810705648fd512b658573960e486b72e02961f2d3ead6\">\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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paylead\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0465ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/program/api/legacy/1.1.10/connector/brands/get-brands.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paylead.fr/#organization\",\"name\":\"Paylead\",\"url\":\"https://docs.paylead.fr\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paylead-04d0cbf1/5Du5nX6Yx2FNkQMU/logo/paylead-light.svg?fit=max\u0026auto=format\u0026n=5Du5nX6Yx2FNkQMU\u0026q=85\u0026s=ccd3972668e08f641390b653caf833dc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paylead.fr#website\",\"name\":\"Paylead\",\"url\":\"https://docs.paylead.fr\",\"publisher\":{\"@id\":\"https://docs.paylead.fr/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands#webpage\",\"url\":\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands\",\"name\":\"Get Brands\",\"description\":\"List of all brands that are allowed to be published on your program.\",\"dateModified\":\"2026-10-27T13:02:09.987Z\",\"isPartOf\":{\"@id\":\"https://docs.paylead.fr#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Paylead\",\"item\":\"https://docs.paylead.fr\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Brands\",\"item\":\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands#apireference\",\"headline\":\"Get Brands\",\"name\":\"Get Brands\",\"description\":\"List of all brands that are allowed to be published on your program.\",\"url\":\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paylead.fr/program/api/legacy/1.1.10/connector/brands/get-brands#webpage\"},\"dateModified\":\"2026-10-27T13:02:09.987Z\",\"publisher\":{\"@id\":\"https://docs.paylead.fr/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paylead.fr#website\"}}]}\u003c/script>","agentPointerHref":"/program/api/legacy/1.1.10/connector/brands/get-brands.md","siteName":"Paylead","nav":{"global":null,"products":[{"product":"Program","icon":"landmark","description":"Documentation for Paylead bank partners","tabs":[{"tab":"Documentation","icon":"book","pages":[{"title":"Documentation","href":"/program/user-journey/what-is-paylead"}]},{"tab":"API","icon":"code","pages":[{"title":"API","href":"/program/api/overview"}]},{"tab":"Connector v1.1.12","hidden":true,"pages":[{"title":"Connector v1.1.12","href":"/program/api/legacy/1.1.12/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.11","hidden":true,"pages":[{"title":"Connector v1.1.11","href":"/program/api/legacy/1.1.11/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.10","hidden":true,"groups":[{"group":"Banks","pages":[{"title":"Gets the list of banks.","description":"Returns the list of all banks available on the program linked to the consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /banks","href":"/program/api/legacy/1.1.10/connector/banks/gets-the-list-of-banks"}]},{"group":"Bank Synchronization","pages":[{"title":"Gets Bank Synchronization Statuses","description":"Retrieves all bank synchronization statuses for all consumers of your program:\n- UNKNOWN: The status is unknown, most of the time because the consumer hasn't synced his/her account yet.\n- DISABLED: The synchronization has been disabled for this connection.\n- ERROR: Synchronization error (bad credentials and/or consumer has an action to make on his/her bank website side).\n- CHALLENGE_REQUIRED: Consumer has to input a special code sent by his/her bank to acknowledge the synchronization.\n- SCRAPPING: The consumer's bank account is being synchronized.\n- SUCCESS: The consumer's bank account synchronization succeeded.\n- SCA_REQUIRED: A complete SCA process must be performed by updating the connection.\n- SCA_REQUIRED_AND_OTP: A complete SCA process must be performed by updating the connection.\n- WEBAUTH_REQUIRED: A complete authentication process is required by updating the connection via redirect.\n- WRONG_PASS: The consumer has to input their credentials because they are invalid or obsolete.\n- ACTION_NEEDED: The consumer has to perform a special action in their bank website. More details are available in \"error_message\".\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connections-statuses","href":"/program/api/legacy/1.1.10/connector/bank-synchronization/gets-bank-synchronization-statuses"},{"title":"Generates Bank Synchronization Webview","description":"This route returns a dedicated Budget Insight webview for the\nspecified consumer to add and synchronize a bank account.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/accounts/webview","href":"/program/api/legacy/1.1.10/connector/bank-synchronization/generates-bank-synchronization-webview"},{"title":"Gets the list of bank connections.","description":"Returns the list of all bank connections of a given consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/banks","href":"/program/api/legacy/1.1.10/connector/bank-synchronization/gets-the-list-of-bank-connections"},{"title":"Gets bank connection details.","description":"Returns a specific synced bank of a consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/banks/{provider_id}","href":"/program/api/legacy/1.1.10/connector/bank-synchronization/gets-bank-connection-details"},{"title":"Gets Bank Synchronization Statuses","description":"Retrieves all bank synchronization statuses for all consumers of your program:\n- UNKNOWN: The status is unknown, most of the time because the consumer hasn't synced his/her account yet.\n- DISABLED: The synchronization has been disabled for this connection.\n- ERROR: Synchronization error (bad credentials and/or consumer has an action to make on his/her bank website side).\n- CHALLENGE_REQUIRED: Consumer has to input a special code sent by his/her bank to acknowledge the synchronization.\n- SCRAPPING: The consumer's bank account is being synchronized.\n- SUCCESS: The consumer's bank account synchronization succeeded.\n- SCA_REQUIRED: A complete SCA process must be performed by updating the connection.\n- SCA_REQUIRED_AND_OTP: A complete SCA process must be performed by updating the connection.\n- WEBAUTH_REQUIRED: A complete authentication process is required by updating the connection via redirect.\n- WRONG_PASS: The consumer has to input their credentials because they are invalid or obsolete.\n- ACTION_NEEDED: The consumer has to perform a special action in their bank website. More details are available in \"error_message\".\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/connections-statuses","href":"/program/api/legacy/1.1.10/connector/bank-synchronization/gets-bank-synchronization-statuses-1"}]},{"group":"Brands","pages":[{"title":"Get Brands","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/brands","href":"/program/api/legacy/1.1.10/connector/brands/get-brands"},{"title":"Gets consumers offer statistics for each brand.","description":"\nList of all brands with offers statistics: Number active or published offers,\nminimum \u0026 maximum reward rates available.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/brands/offer-statistics","href":"/program/api/legacy/1.1.10/connector/brands/gets-consumers-offer-statistics-for-each-brand"},{"title":"Gets consumers offer for a brand.","description":"\nReturns the list of active or published offers for this brand for this specific\nconsumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/brands/{brand_id}/offers","href":"/program/api/legacy/1.1.10/connector/brands/gets-consumers-offer-for-a-brand"},{"title":"Gets the list of offers for a brand.","description":"\nReturns the list of public active or published offers for this brand.\n\nThis list is sorted by default using the conversion probability computed by our internal smart ranking engine.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/brands/offer-statistics","href":"/program/api/legacy/1.1.10/connector/brands/gets-the-list-of-offers-for-a-brand"},{"title":"Gets consumers offer for a brand.","description":"\nReturns the list of active or published offers for this brand for this specific\nconsumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/brands/{brand_id}/offers","href":"/program/api/legacy/1.1.10/connector/brands/gets-consumers-offer-for-a-brand-1"}]},{"group":"User","pages":[{"title":"Create Consumer","description":"\nCreate a consumer by providing:\n- its id (consumer_id)\n- its levels of consent he wants to opt-in in addition to the implicit defined in current privacy policy (extra_levels).\n- its levels of consent he wants to opt-out (removed_consents).\nMultiple choices are allowed and possible choices are: TRANSACTION_TRIGGERS, TARGETING, STATISTICS, SMART_RANKING and WEB_ANALYTICS.\n- its associated account ids under linked banks (banks).\n\nYou can choose any consumer ID you want, as long as it is not already used by an existing consumer in your\nprogram.\n\nIf success, the route answers back with the new consumer ID.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers","href":"/program/api/legacy/1.1.10/connector/user/create-consumer"},{"title":"Check whether a consumer user exists.","description":"Verify existence of a consumer. If present, the route answers back with the consumer id.","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}","href":"/program/api/legacy/1.1.10/connector/user/check-whether-a-consumer-user-exists"},{"title":"Deactivate a consumer","description":"\nDeactivates a specific consumer from your program.\n\nDeactivation deletes everything about this consumer, excepted the cashbacked transactions\n(that remains anonymous, but that we need to keep for audit purposes).\n\nThis action is definitive.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/deactivate","href":"/program/api/legacy/1.1.10/connector/user/deactivate-a-consumer"}]},{"group":"Accounts","pages":[{"title":"Lists the accounts","description":"Lists the different bank accounts synced by the consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/accounts","href":"/program/api/legacy/1.1.10/connector/accounts/lists-the-accounts"},{"title":"Set Master Account (Deprecated, use Create Payment Account Instead).","description":"\nCreates an account or updates the account to master account.\nMaster Account: We transfer the cashback money to this consumer's account. Only one account can be master at a time.\nThe account is eligible if and only if the currency is \"EUR\", and the account type is \"current\".\nAs being deprecated, we recommend that you use Payment Account instead.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/accounts/{account_id}/master","href":"/program/api/legacy/1.1.10/connector/accounts/set-master-account-deprecated-use-create-payment-account-instead"}]},{"group":"Payment Account","pages":[{"title":"Gets Payment Account Listing","description":"\nGets the consumer Payment Account Listing.\n\nA Payment Account is an object describing where the cashback money should be transfered.\n\nIt has:\n\n- A payout account: Where the cashback money should be transfered out of the Payment\nService Provider.\n\n- A target account: Where the cashback money should end up. This is the actual\naccount of the consumer.\n\nIf external ventilation, the payout account is the Program Manager pivot account,\nand the target account is the account of the consumer.\n\nIn case of internal ventilation, payout account = target account = account of\nthe consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/accounts/payment","href":"/program/api/legacy/1.1.10/connector/payment-account/gets-payment-account-listing"},{"title":"Create Payment Account","description":"\nThis route allows the connector to create a payment account from consumer's target\naccount input.\n\nIt also allows you to update the status of the consumer account if that\nthe account is not valid anymore (payment failure for instance).\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/accounts/payment","href":"/program/api/legacy/1.1.10/connector/payment-account/create-payment-account"},{"title":"Gets Payment Account","description":"\nRetrieves a specific payment account from the consumer.\n\nA Payment Account is an object describing where the cashback money should be transfered.\n\nIt has:\n\n- A payout account: Where the cashback money should be transfered out of the Payment\nService Provider.\n\n- A target account: Where the cashback money should end up. This is the actual\naccount of the consumer.\n\nIf external ventilation, the payout account is the Program Manager pivot account,\nand the target account is the account of the consumer.\n\nIn case of internal ventilation, payout account = target account = account of\nthe consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/accounts/payment/{mpa_id}","href":"/program/api/legacy/1.1.10/connector/payment-account/gets-payment-account"},{"title":"Deletes Payment Account.","description":"\nRoute to delete the consumers payment account.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json delete /connectors/consumers/{consumer_id}/accounts/payment/{mpa_id}","href":"/program/api/legacy/1.1.10/connector/payment-account/deletes-payment-account"}]},{"group":"Reward","pages":[{"title":"Gets Cashbacks","description":"This method returns the paginated listing of all cashbacks belonging to a specific\nconsumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/cashbacks","href":"/program/api/legacy/1.1.10/connector/reward/gets-cashbacks"},{"title":"Retrieves a cashback.","description":"Returns this specific cashback details.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/cashbacks/{cashback_id}","href":"/program/api/legacy/1.1.10/connector/reward/retrieves-a-cashback"},{"title":"Get the list of rewards.","description":"\nReturns the list of all the rewards generated for a consumer (gifts and cashbacks).\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/rewards","href":"/program/api/legacy/1.1.10/connector/reward/get-the-list-of-rewards"},{"title":"Listing of affiliation Cashback.","description":"Returns the list of all the affiliation rewards generated for a consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/rewards/affiliation/cashbacks/","href":"/program/api/legacy/1.1.10/connector/reward/listing-of-affiliation-cashback"},{"title":"Retrieves an affiliation cashback.","description":"Returns this specific cashback details.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/rewards/affiliation/cashbacks/{cashback_id}","href":"/program/api/legacy/1.1.10/connector/reward/retrieves-an-affiliation-cashback"},{"title":"Gets the list of cashbacks.","description":"\nReturns the list of all the cashbacks generated for a consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/rewards/cashbacks","href":"/program/api/legacy/1.1.10/connector/reward/gets-the-list-of-cashbacks"},{"title":"Retrieves a reward.","description":"Returns this specific reward details.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_id}","href":"/program/api/legacy/1.1.10/connector/reward/retrieves-a-reward"},{"title":"Rewards cashback timeline","description":"Returns this specific rewards timeline, i.e. all the different states of this\ncashback, through time.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/rewards/cashbacks/{reward_id}/timeline","href":"/program/api/legacy/1.1.10/connector/reward/rewards-cashback-timeline"},{"title":"Retrieves a gift.","description":"Returns this specific gift details.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/rewards/gifts/{gift_id}","href":"/program/api/legacy/1.1.10/connector/reward/retrieves-a-gift"},{"title":"Rewards gift timeline","description":"Returns this specific gift's timeline, i.e. all the different states of this\ngift, through time.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/rewards/gifts/{reward_id}/timeline","href":"/program/api/legacy/1.1.10/connector/reward/rewards-gift-timeline"}]},{"group":"Kycs","pages":[{"title":"Edition of KYC","description":"Edits the consumer declarative information on our PSP side.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json put /connectors/consumers/{consumer_id}/kyc","href":"/program/api/legacy/1.1.10/connector/kycs/edition-of-kyc"},{"title":"Creation of KYC","description":"Registers this consumer on our PSP with the different information needed for the light\nverification.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/kyc","href":"/program/api/legacy/1.1.10/connector/kycs/creation-of-kyc"}]},{"group":"Metrics","pages":[{"title":"Metrics Global","description":"This route allows you to get the cashbacks of a specific consumer, ventilated per status.\nCashback statuses are:\n- PENDING: The cashback has been generated but is not yet validated (PENDING_VALIDATION). total_pending_cashback_amount\n- VALIDATED: A cashback that has passed the validation period (e.g. 14 days of retraction for a classical purchase). The cashback can't be cancelled when validated total_validated_cashback_amount.\n- PAID_IN: The cashback money has been collected from the merchant, but not yet transfered (paid out) to the consumer. total_paid_in_cashback_amount\n- PAID_OUT: The cashback money has been transfered to the consumer pay out account. total_paid_out_cashback_amount\n- CANCELLED: The cashback has been cancelled. total_cancelled_cashback_amount\nWe also return the total number of cashbacks since user acceptance of the terms of services and the total amount of cashbacks, whatever the status.\nDo not compute cancelled cashbacks in total amount and total cashbacks.\nThis is especially useful for programs with pool, enabling to show how much money has been collected so far, but not yet transferred to the consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/metrics","href":"/program/api/legacy/1.1.10/connector/metrics/metrics-global"},{"title":"Metrics monthly","description":"This route allows you to get the cashbacks of a specific consumer, ventilated per status and per month.\nCashback Status are :\n- PENDING Cashback has been generated, but is not yet validated (PENDING_VALIDATION) total_pending_cashback_amount\n- VALIDATED A cashback that has passed the validation period (e.g. 14 days of retraction for a classical purchase). The cashback can't be cancelled when validated total_validated_cashback_amount\n- PAID_IN Cashback money has been collected from the merchant, but not yet transfered (paid out) to the consumer. total_paid_in_cashback_amount\n- PAID_OUT Cashback money has been transfered to the consumer pay out account. total_paid_out_cashback_amount\n- CANCELLED The cashback has been cancelled. total_cancelled_cashback_amount\nWe also return the total number of cashbacks since user acceptance of the terms of services and the total amount of cashback, whatever the status is.\nDont compute cancelled cashbacks in total amount and total cashbacks\nThis is especially useful for programs with cagnotte, allowing to show how much money have been collected so far, but not yet transferred to the consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/metrics/by_month","href":"/program/api/legacy/1.1.10/connector/metrics/metrics-monthly"}]},{"group":"Offers","pages":[{"title":"Offers Consumer Listing","description":"\nGets a paginated list of all offers available for the current consumer: generic\noffers + offers where this consumer is targeted.\n\nFor all your logged consumers, you must actually use this route to retrieve\nthe best set of offers dedicated to each consumer.\n\nThis list can be filtered by offer types, start date, end date, universe, highlight\nlevel...\n\nThe list contains all the active offers (status = ACTIVE) and offers to come (status\n= PUBLISHED).\n\nThis list is sorted by default using the conversion probability computed by our internal smart ranking engine.\n\nPagination of 20 items by default.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/offers","href":"/program/api/legacy/1.1.10/connector/offers/offers-consumer-listing"},{"title":"Gets Offer Details","description":"Gets the offer object that has the ID attribute with the specified value.\nThis route allows you to get the details of a specific offer, from the perspective of a generic consumer.\nIf the consumer hasn't access to the offer (because the offer is deactivated or doesn't exist or is not generic i.e. is targeted), the response will be a 404 Error.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/offers/{offer_id}","href":"/program/api/legacy/1.1.10/connector/offers/gets-offer-details"},{"title":"Generates Offer Coupon","description":"\nGenerates a coupon for the consumer and decrements the total number of available coupons for this offer by 1.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/offers/{offer_id}/consume","href":"/program/api/legacy/1.1.10/connector/offers/generates-offer-coupon"},{"title":"Gets the list of consumed coupons","description":"\nLists all coupons consumed by the given users for the current offer coupon.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/offers/{offer_id}/coupons","href":"/program/api/legacy/1.1.10/connector/offers/gets-the-list-of-consumed-coupons"},{"title":"Retrieves the code associated with the consumed coupon.","description":"\nRetrieves the QR/BarCode or alphanumeric code associated to the consumed coupon.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/offers/{offer_id}/coupons/{coupon_id}","href":"/program/api/legacy/1.1.10/connector/offers/retrieves-the-code-associated-with-the-consumed-coupon"},{"title":"Favorites an Offer","description":"\nThis route allows the connector to favorite a specific offer for a specific consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json put /connectors/consumers/{consumer_id}/offers/{offer_id}/favorite","href":"/program/api/legacy/1.1.10/connector/offers/favorites-an-offer"},{"title":"Unfavorites an Offer","description":"\nThis route allows the connector to unfavorite a specific offer for a specific\nconsumer. If the offer was not previously favorited, it has no effects.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json delete /connectors/consumers/{consumer_id}/offers/{offer_id}/favorite","href":"/program/api/legacy/1.1.10/connector/offers/unfavorites-an-offer"},{"title":"Reserves a voucher on a given brand.","description":"\nInitiates the creation of a voucher for the requested value or price, depending on the reservation mode\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/offers/{offer_id}/voucher","href":"/program/api/legacy/1.1.10/connector/offers/reserves-a-voucher-on-a-given-brand"},{"title":"Gets the Amount of Offer Per Universe.","description":"Returns the amount of generic offers per status and per universe.","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/universes/offers","href":"/program/api/legacy/1.1.10/connector/offers/gets-the-amount-of-offer-per-universe"},{"title":"Offers Consumer Listing","description":"\nGets a paginated list of all offers available for the current consumer: generic\noffers + offers where this consumer is targeted.\n\nFor all your logged consumers, you must actually use this route to retrieve\nthe best set of offers dedicated to each consumer.\n\nThis list can be filtered by offer types, start date, end date, universe, highlight\nlevel...\n\nThe list contains all the active offers (status = ACTIVE) and offers to come (status\n= PUBLISHED).\n\nThis list is sorted by default using the conversion probability computed by our internal smart ranking engine.\n\nPagination of 20 items by default.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /offers","href":"/program/api/legacy/1.1.10/connector/offers/offers-consumer-listing-1"},{"title":"Gets Offer Details","description":"Gets the offer object that has the ID attribute with the specified value.\nThis route allows you to get the details of a specific offer, from the perspective of a generic consumer.\nIf the consumer hasn't access to the offer (because the offer is deactivated or doesn't exist or is not generic i.e. is targeted), the response will be a 404 Error.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /offers/{offer_id}","href":"/program/api/legacy/1.1.10/connector/offers/gets-offer-details-1"},{"title":"Gets the Amount of Offer Per Universe.","description":"Returns the amount of generic offers per status and per universe.","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /universes/offers","href":"/program/api/legacy/1.1.10/connector/offers/gets-the-amount-of-offer-per-universe-1"}]},{"group":"Personal Finance Manager","pages":[{"title":"Get Account","description":"Returns a specific account information, with balance.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/pfm/accounts/{account_id}","href":"/program/api/legacy/1.1.10/connector/personal-finance-manager/get-account"},{"title":"Gets Balances by Universes","description":"Gets aggregated positive (use balance type = gains) or negative (use balance type = expenses) transaction amount grouped by universe.\nThis route accepts same filters as transactions, allowing you to recompute expenses as you need. For instance, choosing a specific list of universes, for a specific time window, on a specific account etc...\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/pfm/balance/{balance_type}","href":"/program/api/legacy/1.1.10/connector/personal-finance-manager/gets-balances-by-universes"},{"title":"Get Bank","description":"Returns the synchronized banks of a consumer.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/pfm/banks","href":"/program/api/legacy/1.1.10/connector/personal-finance-manager/get-bank"},{"title":"Gets Bank Details","description":"Returns a specific synchronized bank of a consumer\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/pfm/banks/{bank_id}","href":"/program/api/legacy/1.1.10/connector/personal-finance-manager/gets-bank-details"},{"title":"Deletes Consumer Bank Connection","description":"Route to delete the Consumer Bank Connection. It deletes all non-cashbacked transactions\nfrom this bank, but keep the cashbacked transactions for audit purpose. Every\nother information is deleted.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json delete /connectors/consumers/{consumer_id}/pfm/banks/{bank_id}","href":"/program/api/legacy/1.1.10/connector/personal-finance-manager/deletes-consumer-bank-connection"}]},{"group":"Pools","pages":[{"title":"Gets Pooled Cashback (Cagnotte).","description":"\nGets the sum of all \"Paid In\" cashbacks of a given consumer. \"Paid In\" cashbacks are\ncashbacks that are already paid by the merchants. They form what we call the consumer\nPool (Cagnotte).\n\nReturns also the Program Threshold configuration:\n\nManual \u0026 Automatic Threshold\n\n0 =\u003c C \u003c Manual Threshold Trigger Cashback is locked in the PAID IN status, no\naction possible.\n\nManual Threshold Trigger =\u003c C \u003c Automatic Threshold Trigger Cashback can be manually\ntransfered by the consumer.\n\nC >= Automatic Threshold Trigger Cashback is automatically transfered by the consumer\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/pools/me","href":"/program/api/legacy/1.1.10/connector/pools/gets-pooled-cashback-cagnotte"},{"title":"Manually Trigger Pool (Cagnotte)","description":"\nThis route allows the consumer to unlock his/her pool (cagnotte), and get the\nactual money paid out to his/her account. Only cashbacks with status paid in (which\nmeans actually paid by the merchant) are meant to be paid out. Manual trigger\nis only possible if the total sum of PAID IN Cashback is greater than the manual\nthreshold, defined at the Program Manager level.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json put /connectors/consumers/{consumer_id}/pools/me/consume","href":"/program/api/legacy/1.1.10/connector/pools/manually-trigger-pool-cagnotte"}]},{"group":"Policies","pages":[{"title":"Gets consumers privacy level details.","description":"\nRetrieves the current version of the privacy policy level.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/programs/me/privacy/{level}","href":"/program/api/legacy/1.1.10/connector/policies/gets-consumers-privacy-level-details"},{"title":"Accepts consumers privacy level.","description":"\nConsents to the given privacy policy level.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/users/me/consent/{level}","href":"/program/api/legacy/1.1.10/connector/policies/accepts-consumers-privacy-level"},{"title":"Delete consumers privacy level.","description":"Removes privacy policy consent.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json delete /connectors/consumers/{consumer_id}/users/me/consent/{level}","href":"/program/api/legacy/1.1.10/connector/policies/delete-consumers-privacy-level"},{"title":"Gets consumers privacy level details.","description":"\nRetrieves the current version of the privacy policy level.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /programs/me/privacy/{level}","href":"/program/api/legacy/1.1.10/connector/policies/gets-consumers-privacy-level-details-1"}]},{"group":"Segment","pages":[{"title":"Lists segments.","description":"List the different active segments of a consumer\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/segments","href":"/program/api/legacy/1.1.10/connector/segment/lists-segments"},{"title":"Adds to segment.","description":"Assigns a consumer to a segment. To create new segments, contact PayLead support. \\nA segment is an attribute, e.g. \\\"premium customers\\\", allowing\n you to create specific offers for specific group of customers.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json post /connectors/consumers/{consumer_id}/segments/{segment_id}","href":"/program/api/legacy/1.1.10/connector/segment/adds-to-segment"},{"title":"Removes from segment.","description":"\nRemoves a consumer from a segment\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json delete /connectors/consumers/{consumer_id}/segments/{segment_id}","href":"/program/api/legacy/1.1.10/connector/segment/removes-from-segment"}]},{"group":"Voucher","pages":[{"title":"Retrieves the lists of vouchers for a given consumer.","description":"Retrieves the lists of vouchers for a given consumer.","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/vouchers","href":"/program/api/legacy/1.1.10/connector/voucher/retrieves-the-lists-of-vouchers-for-a-given-consumer"},{"title":"Retrieves the details of a voucher for a given consumer.","description":"Retrieves the details of a voucher for a given consumer.","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/vouchers/{voucher_id}","href":"/program/api/legacy/1.1.10/connector/voucher/retrieves-the-details-of-a-voucher-for-a-given-consumer"},{"title":"Cancels a previously reserved voucher.","description":"Cancels a previously reserved voucher.","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json delete /connectors/consumers/{consumer_id}/vouchers/{voucher_id}/cancel","href":"/program/api/legacy/1.1.10/connector/voucher/cancels-a-previously-reserved-voucher"},{"title":"Confirms a voucher previously reserved.","description":"\nConfirms a voucher previously reserved.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json put /connectors/consumers/{consumer_id}/vouchers/{voucher_id}/confirmation","href":"/program/api/legacy/1.1.10/connector/voucher/confirms-a-voucher-previously-reserved"},{"title":"Downloads the voucher as a file.","description":"Downloads the voucher as a file.","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/consumers/{consumer_id}/vouchers/{voucher_id}/download","href":"/program/api/legacy/1.1.10/connector/voucher/downloads-the-voucher-as-a-file"}]},{"group":"Store","pages":[{"title":"Get Stores List.","description":"This route returns a paginated list of stores.\nWe return a list of stores, and in each store we embed the list of related offers, whatever the type and/or cashback rate.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/stores","href":"/program/api/legacy/1.1.10/connector/store/get-stores-list"},{"title":"Gets Store Detail.","description":"This route returns the details of a given store, embedding the best generic offer, if any.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /connectors/stores/{store_id}","href":"/program/api/legacy/1.1.10/connector/store/gets-store-detail"},{"title":"Gets Store List.","description":"\nThis route returns a paginated list of stores\nWe return a list of stores, and in each store we embed the list of related offers, whatever the type and/or cashback rate.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /stores","href":"/program/api/legacy/1.1.10/connector/store/gets-store-list"},{"title":"Get Store Detail","description":"\nThis route returns the details of a given store, embedding the best generic offer,\nif any.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /stores/{store_id}","href":"/program/api/legacy/1.1.10/connector/store/get-store-detail"}]},{"group":"Files","pages":[{"title":"Download File","description":"\nRetrieves the URL to download a file.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /files/{media_id}","href":"/program/api/legacy/1.1.10/connector/files/download-file"},{"title":"Preview File","description":"\nRetrieves the URL to preview a file.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /files/{media_id}/preview","href":"/program/api/legacy/1.1.10/connector/files/preview-file"}]},{"group":"Universe","pages":[{"title":"Get Universes","description":"Returns the list of all PayLead Merchant universes.\nThis list contains nested universes, e.g. \"Alimentation\", which cointains \"Supermarché\", \"Boucher/Poissonnier\", \"Boulanger\" etc...\nEach universe has a unique UUID, and this UUID should be used for calling the API when filtering or querying on specific universes.\n","deprecated":null,"version":null,"openapi":"/program/api/openapi/legacy/1.1.10/connector.json get /universes","href":"/program/api/legacy/1.1.10/connector/universe/get-universes"}]}]},{"tab":"Connector v1.1.9","hidden":true,"pages":[{"title":"Connector v1.1.9","href":"/program/api/legacy/1.1.9/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.8","hidden":true,"pages":[{"title":"Connector v1.1.8","href":"/program/api/legacy/1.1.8/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.7","hidden":true,"pages":[{"title":"Connector v1.1.7","href":"/program/api/legacy/1.1.7/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.6","hidden":true,"pages":[{"title":"Connector v1.1.6","href":"/program/api/legacy/1.1.6/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.5","hidden":true,"pages":[{"title":"Connector v1.1.5","href":"/program/api/legacy/1.1.5/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.4","hidden":true,"pages":[{"title":"Connector v1.1.4","href":"/program/api/legacy/1.1.4/connector/banks/gets-the-list-of-banks"}]},{"tab":"M2M v1.1.4","hidden":true,"pages":[{"title":"M2M v1.1.4","href":"/program/api/legacy/1.1.4/m2m/lbs/get-the-lbs-strategies"}]},{"tab":"Connector v1.1.3","hidden":true,"pages":[{"title":"Connector v1.1.3","href":"/program/api/legacy/1.1.3/connector/banks/gets-the-list-of-banks"}]},{"tab":"M2M v1.1.3","hidden":true,"pages":[{"title":"M2M v1.1.3","href":"/program/api/legacy/1.1.3/m2m/lbs/get-the-lbs-strategies"}]},{"tab":"Connector v1.1.2","hidden":true,"pages":[{"title":"Connector v1.1.2","href":"/program/api/legacy/1.1.2/connector/banks/gets-the-list-of-banks"}]},{"tab":"Injector v1.1.2","hidden":true,"pages":[{"title":"Injector v1.1.2","href":"/program/api/legacy/1.1.2/injector/health/health-check"}]},{"tab":"M2M v1.1.2","hidden":true,"pages":[{"title":"M2M v1.1.2","href":"/program/api/legacy/1.1.2/m2m/lbs/get-the-lbs-strategies"}]},{"tab":"Connector v1.1.1","hidden":true,"pages":[{"title":"Connector v1.1.1","href":"/program/api/legacy/1.1.1/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.0","hidden":true,"pages":[{"title":"Connector v1.1.0","href":"/program/api/legacy/1.1.0/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.0.1","hidden":true,"pages":[{"title":"Connector v1.0.1","href":"/program/api/legacy/1.0.1/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.0.0","hidden":true,"pages":[{"title":"Connector v1.0.0","href":"/program/api/legacy/1.0.0/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v0.3.0","hidden":true,"pages":[{"title":"Connector v0.3.0","href":"/program/api/legacy/0.3.0/connector/banks/gets-the-list-of-banks"}]},{"tab":"WebApp","icon":"smartphone","pages":[{"title":"WebApp","href":"/program/webapp/overview"}]},{"tab":"Link","icon":"network","hidden":true,"pages":[{"title":"Link","href":"/program/link/overview"}]},{"tab":"Shift","icon":"shuffle","pages":[{"title":"Shift","href":"/program/shift/overview"}]},{"tab":"LBS","icon":"store","hidden":true,"pages":[{"title":"LBS","href":"/program/lbs/overview"}]},{"tab":"Reference","icon":"eye-off","hidden":true,"pages":[{"title":"Reference","href":"/program/user-journey/concepts/autonomous-ventilation"}]},{"tab":"Glossary","icon":"book-open-text","pages":[{"title":"Glossary","href":"/glossary"}]}]},{"product":"Retailers","icon":"store","description":"Documentation for Paylead merchant partners","pages":[{"title":"Retailers","href":"/retailers/guides/sales-report-automation"}]}]},"basePath":"","title":"Get Brands - Paylead","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}