{
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid or expired API key"
}
}
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please retry after the reset period."
}
}
Returns a page of customers for your company. Each item uses the same shape as Get Customer, so every customer carries its additionalData field map and subscriptionStatus entries.
limit caps at 100 per page. When you are syncing additional data fields for a large audience, page through with sort=updatedAt:desc and stop once you reach records you already have.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"bitbybit","colors":{"primary":"#ff734c","light":"#fc7b54","dark":"#ff734c"},"logo":{"light":"https://mintcdn.com/asmaraku/WlT_6AuzhITpdgTf/logo/bbb-logo-default.png?fit=max\u0026auto=format\u0026n=WlT_6AuzhITpdgTf\u0026q=85\u0026s=7690f415d4b16eb95a47bd01fe7c938d","dark":"https://mintcdn.com/asmaraku/WlT_6AuzhITpdgTf/logo/bbb-logo-light.png?fit=max\u0026auto=format\u0026n=WlT_6AuzhITpdgTf\u0026q=85\u0026s=4aaa8d3bd2de358414b495349a279a6b"},"favicon":{"light":"https://mintcdn.com/asmaraku/cHM4z2t-1XWdSut8/bbb-icon.png?fit=max\u0026auto=format\u0026n=cHM4z2t-1XWdSut8\u0026q=85\u0026s=7f39b6b551ded4c62302624137f090e3","dark":"https://mintcdn.com/asmaraku/cHM4z2t-1XWdSut8/bbb-icon.png?fit=max\u0026auto=format\u0026n=cHM4z2t-1XWdSut8\u0026q=85\u0026s=7f39b6b551ded4c62302624137f090e3"},"api":{"openapi":["api-reference/openapi/customers.json","api-reference/openapi/messaging.json","api-reference/openapi/analytics.json","api-reference/openapi/loyalty-bitlogin.json","api-reference/openapi/loyalty-customers.json","api-reference/openapi/shipping.json"]},"navbar":{"primary":{"type":"button","label":"Support","href":"https://api.whatsapp.com/send/?phone=6281514231000\u0026text=Hello+bitbybit+team%2C+I+need+some+assistance"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"integrations":{"gtm":{"tagId":"GTM-KQ6RZZG"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"asmaraku","hasAudioNarration":false,"actualSubdomain":"asmaraku","customDomains":["knowledge.bitbybit.studio"],"gitSource":{"type":"github","owner":"asmaraku","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aec62a30c9d6432d6b3b0fb","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":122},{"language":"default","tag":"bitCRM","count":100},{"language":"default","tag":"bitChat","count":96},{"language":"default","tag":"AI Studio","count":48},{"language":"default","tag":"bitLink","count":44},{"language":"default","tag":"WhatsApp Commerce","count":44},{"language":"default","tag":"bitApp","count":42},{"language":"default","tag":"Integrations","count":34},{"language":"default","tag":"Settings","count":24},{"language":"default","tag":"Configure","count":21}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":":is(#sidebar-content,#mobile-nav):has(a[href=\"/integrations/overview\"],a[href=\"/bitcrm/overview\"],a[href=\"/bitchat/overview\"],a[href=\"/bitapp/overview\"],a[href=\"/bitlink/overview\"],a[href=\"/loyalty/overview\"],a[href=\"/ai-studio/overview\"],a[href=\"/whatsapp-commerce/overview\"],a[href=\"/settings/overview\"],a[href=\"/api-reference/introduction\"]) .sidebar-group-header{display:none}:is(#sidebar-content,#mobile-nav):has(a[href=\"/integrations/overview\"],a[href=\"/bitcrm/overview\"],a[href=\"/bitchat/overview\"],a[href=\"/bitapp/overview\"],a[href=\"/bitlink/overview\"],a[href=\"/loyalty/overview\"],a[href=\"/ai-studio/overview\"],a[href=\"/whatsapp-commerce/overview\"],a[href=\"/settings/overview\"],a[href=\"/api-reference/introduction\"]) li>:is(a,button){padding-block:10px}:is(#sidebar-content,#mobile-nav) li[data-active=\"true\"]>button{font-weight:700}#body-content:has(#sidebar-content a[href=\"/integrations/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/bitcrm/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/bitchat/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/bitapp/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/bitlink/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/loyalty/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/ai-studio/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/whatsapp-commerce/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/settings/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/api-reference/introduction\"][aria-current=\"page\"]) #header .eyebrow{display:none}#body-content:has(#sidebar-content a[href=\"/integrations/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/bitcrm/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/bitchat/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/bitapp/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/bitlink/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/loyalty/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/ai-studio/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/whatsapp-commerce/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/settings/overview\"][aria-current=\"page\"],#sidebar-content a[href=\"/api-reference/introduction\"][aria-current=\"page\"]) #header .eyebrow+div{margin-block-start:0}"}],"page":{"pagePath":"api-reference/endpoint/customers/list","slug":"/api-reference/endpoint/customers/list","pageMetadata":{"title":"List Customers","description":"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.","openapi":"GET /customers","type":"reference","last_verified":"2026-08-19","href":"/api-reference/endpoint/customers/list"},"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: \"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Tip}=_components;if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns a page of customers for your company. Each item uses the same shape as `,_jsx(_components.a,{href:`/api-reference/endpoint/customers/get`,children:`Get Customer`}),`, so every customer carries its `,_jsx(_components.code,{children:`additionalData`}),` field map and `,_jsx(_components.code,{children:`subscriptionStatus`}),` entries.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`limit`}),` caps at 100 per page. When you are syncing additional data fields for a large audience, page through with `,_jsx(_components.code,{children:`sort=updatedAt:desc`}),` and stop once you reach records you already have.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Customers","description":"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.","openapi":"GET /customers","type":"reference","last_verified":"2026-08-19","href":"/api-reference/endpoint/customers/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/asmaraku/fc5a36b1d957f891/gtm.js","/_mintlify/custom/asmaraku/1c64b6fee57ecbb2/support-whatsapp.js","/_mintlify/custom/asmaraku/a513d42309b690fd/livechat-widget.js"],"openApiReferenceData":{"operation":{"operationId":"listCustomers","summary":"List customers","description":"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.","tags":["Customers"],"parameters":["5d573933-be41-486d-8962-6c5f55f351fc","ae0e08e6-7723-4b2c-99b3-e1850e4c7c7b","1115b934-ba3f-4a77-a184-d3e3b39083ad","2840d64a-ae5d-413d-a316-b11b8607e872","e3e6f56d-e031-4c66-b80b-33098d3c8c45","1fa2e772-9dfb-4971-a5e7-fb78a536ee18"],"responses":{"200":"e8e8ec22-ebbc-4d7e-a6ce-1b1393c11127","401":"fa38fa79-9188-4fd2-a943-50198efa4488","429":"d0994b4e-4aa2-4a67-be90-32a2bcef4aca"},"method":"get","type":"path","servers":["9dc81b56-f92e-44e4-91b2-1b0f6ff827cf"],"security":["812b1c0f-1dc2-488b-8288-241e787100d4"],"path":"/customers","baseUrlOptions":["https://api.bitbybit.studio/customer/api/open/v1"],"title":"List customers","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5d573933-be41-486d-8962-6c5f55f351fc":{"name":"page","in":"query","schema":{"type":"integer","default":1,"minimum":1,"description":"Page number","uniqueKey":"","typeLabel":"integer"},"description":"Page number"},"ae0e08e6-7723-4b2c-99b3-e1850e4c7c7b":{"name":"limit","in":"query","schema":{"type":"integer","default":20,"minimum":1,"maximum":100,"description":"Number of results per page","uniqueKey":"","typeLabel":"integer"},"description":"Number of results per page"},"1115b934-ba3f-4a77-a184-d3e3b39083ad":{"name":"search","in":"query","schema":{"type":"string","description":"Search by name, email, or phone number","uniqueKey":"","typeLabel":"string"},"description":"Search by name, email, or phone number"},"2840d64a-ae5d-413d-a316-b11b8607e872":{"name":"source","in":"query","schema":{"type":"string","description":"Filter by source values (comma-separated)","uniqueKey":"","typeLabel":"string"},"description":"Filter by source values (comma-separated)"},"e3e6f56d-e031-4c66-b80b-33098d3c8c45":{"name":"tags","in":"query","schema":{"type":"string","description":"Filter by tags (comma-separated)","uniqueKey":"","typeLabel":"string"},"description":"Filter by tags (comma-separated)"},"1fa2e772-9dfb-4971-a5e7-fb78a536ee18":{"name":"sort","in":"query","schema":{"type":"string","default":"updatedAt:desc","description":"Sort field and direction (e.g., updatedAt:desc)","uniqueKey":"","typeLabel":"string"},"description":"Sort field and direction (e.g., updatedAt:desc)"}},"responses":{"e8e8ec22-ebbc-4d7e-a6ce-1b1393c11127":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"email":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].email","typeLabel":"string | null"},"phoneNumber":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].phoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].phoneNumber","typeLabel":"string | null"},"firstName":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].firstName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].lastName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].lastName","typeLabel":"string | null"},"imageUrl":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].imageUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].imageUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].imageUrl","typeLabel":"string | null"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].tags","typeLabel":"string[]"},"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].id","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].firstName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].lastName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].lastName","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].phone","typeLabel":"string | null"},"address1":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].address1.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].address1","typeLabel":"string | null"},"address2":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].address2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].address2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].city","typeLabel":"string | null"},"province":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].province.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].province.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].province","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].country","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].zip.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].zip","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].addresses","typeLabel":"object[]"},"additionalData":{"type":"object","description":"Custom customer fields defined for your company, returned as a flat map of field key to value. Keys match the field keys you configured in Settings; values keep the type they were stored with (string, number, boolean, array, or object). Returns an empty object when the customer has no custom field values.","additionalProperties":true,"example":{"favorite_food":"Nasi Goreng","shirt_size":"L","loyalty_signup_year":2024},"uniqueKey":"data.items.[INDEX].additionalData","typeLabel":"object"},"subscriptionStatus":{"type":"array","description":"Marketing subscription state per bitbybit app. Apps the customer has never been recorded against are omitted.","items":{"type":"object","properties":{"app":{"type":"string","enum":["BITCRM","BITLINK"],"description":"The bitbybit app the subscription state applies to","uniqueKey":"data.items.[INDEX].subscriptionStatus.items.[INDEX].app","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["subscribe","unsubscribe"],"description":"Whether the customer is subscribed to marketing messages for that app","uniqueKey":"data.items.[INDEX].subscriptionStatus.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].subscriptionStatus.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].subscriptionStatus","typeLabel":"object[]"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"data.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"data.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"},"meta":{"type":"object","properties":{"page":{"type":"integer","uniqueKey":"meta.page","typeLabel":"integer"},"limit":{"type":"integer","uniqueKey":"meta.limit","typeLabel":"integer"},"total":{"type":"integer","uniqueKey":"meta.total","typeLabel":"integer"},"hasNextPage":{"type":"boolean","uniqueKey":"meta.hasNextPage","typeLabel":"boolean"}},"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"\u003cstring>","email":"\u003cstring>","phoneNumber":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","imageUrl":"\u003cstring>","tags":["\u003cstring>"],"addresses":[{"id":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>","address1":"\u003cstring>","address2":"\u003cstring>","city":"\u003cstring>","province":"\u003cstring>","country":"\u003cstring>","zip":"\u003cstring>"}],"additionalData":{"favorite_food":"Nasi Goreng","shirt_size":"L","loyalty_signup_year":2024},"subscriptionStatus":[{"app":"BITCRM","status":"subscribe"}],"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}],"meta":{"page":123,"limit":123,"total":123,"hasNextPage":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"fa38fa79-9188-4fd2-a943-50198efa4488":{"description":"Authentication failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_API_KEY","message":"Invalid or expired API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_API_KEY","message":"Invalid or expired API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d0994b4e-4aa2-4a67-be90-32a2bcef4aca":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many requests. Please retry after the reset period."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many requests. Please retry after the reset period."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"812b1c0f-1dc2-488b-8288-241e787100d4":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Create one in Settings > Developer.","scopes":[]}}},"servers":{"9dc81b56-f92e-44e4-91b2-1b0f6ff827cf":{"url":"https://api.bitbybit.studio/customer/api/open/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Create one in Settings > Developer.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. Create one in Settings > Developer.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi/customers.json"},"subdomain":"asmaraku","siteName":"bitbybit","title":"List Customers - bitbybit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-18T23:00:07.952Z","originalFileLocation":"api-reference/endpoint/customers/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=\"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.\">\u003cmeta data-mint-head name=\"application-name\" content=\"bitbybit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/asmaraku/mcooRqJTgM6wbzpL/_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/asmaraku/mcooRqJTgM6wbzpL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/asmaraku/mcooRqJTgM6wbzpL/_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/asmaraku/mcooRqJTgM6wbzpL/_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/asmaraku/mcooRqJTgM6wbzpL/_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/asmaraku/mcooRqJTgM6wbzpL/_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/asmaraku/mcooRqJTgM6wbzpL/_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/asmaraku/mcooRqJTgM6wbzpL/_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/asmaraku/mcooRqJTgM6wbzpL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Customers - bitbybit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"bitbybit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://asmaraku.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=List+Customers\u0026amp;description=Retrieve+a+paginated+list+of+customers%2C+with+search%2C+source%2C+and+tag+filters%2C+sorting%2C+and+additional+data+fields.\u0026amp;theme=a473618703c526131e2b8363\u0026amp;signature=483bfca1a99933fa94847611f2b10a2fc45ad8cacf27197c13135cd3a29f4536\">\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 Customers - bitbybit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://asmaraku.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=List+Customers\u0026amp;description=Retrieve+a+paginated+list+of+customers%2C+with+search%2C+source%2C+and+tag+filters%2C+sorting%2C+and+additional+data+fields.\u0026amp;theme=a473618703c526131e2b8363\u0026amp;signature=483bfca1a99933fa94847611f2b10a2fc45ad8cacf27197c13135cd3a29f4536\">\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/asmaraku/mcooRqJTgM6wbzpL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"bitbybit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff734c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/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/endpoint/customers/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://knowledge.bitbybit.studio/#organization\",\"name\":\"bitbybit\",\"url\":\"https://knowledge.bitbybit.studio\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/asmaraku/WlT_6AuzhITpdgTf/logo/bbb-logo-default.png?fit=max\u0026auto=format\u0026n=WlT_6AuzhITpdgTf\u0026q=85\u0026s=7690f415d4b16eb95a47bd01fe7c938d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://knowledge.bitbybit.studio#website\",\"name\":\"bitbybit\",\"url\":\"https://knowledge.bitbybit.studio\",\"publisher\":{\"@id\":\"https://knowledge.bitbybit.studio/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list#webpage\",\"url\":\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list\",\"name\":\"List Customers\",\"description\":\"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.\",\"dateModified\":\"2026-08-18T23:00:07.952Z\",\"isPartOf\":{\"@id\":\"https://knowledge.bitbybit.studio#website\"},\"breadcrumb\":{\"@id\":\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://knowledge.bitbybit.studio/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Customers\",\"item\":\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list#apireference\",\"headline\":\"List Customers\",\"name\":\"List Customers\",\"description\":\"Retrieve a paginated list of customers, with search, source, and tag filters, sorting, and additional data fields.\",\"url\":\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list\",\"mainEntityOfPage\":{\"@id\":\"https://knowledge.bitbybit.studio/api-reference/endpoint/customers/list#webpage\"},\"dateModified\":\"2026-08-18T23:00:07.952Z\",\"publisher\":{\"@id\":\"https://knowledge.bitbybit.studio/#organization\"},\"isPartOf\":{\"@id\":\"https://knowledge.bitbybit.studio#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"bitbybit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"bitbybit","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":""}]},{"tab":"bitCRM","pages":[{"title":"bitCRM","href":"/bitcrm/overview"}]},{"tab":"bitChat","pages":[{"title":"bitChat","href":"/bitchat/overview"}]},{"tab":"bitApp","pages":[{"title":"bitApp","href":"/bitapp/overview"}]},{"tab":"bitLink","pages":[{"title":"bitLink","href":"/bitlink/overview"}]},{"tab":"bitLoyalty","pages":[{"title":"bitLoyalty","href":"/loyalty/overview"}]},{"tab":"AI Studio","pages":[{"title":"AI Studio","href":"/ai-studio/overview"}]},{"tab":"WhatsApp Commerce","pages":[{"title":"WhatsApp Commerce","href":"/whatsapp-commerce/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Settings","pages":[{"title":"Settings","href":"/settings/overview"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Introduction","sidebarTitle":"API Reference overview","href":"/api-reference/introduction"},{"group":"Getting Started","icon":"rocket","expanded":false,"pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"IP Whitelisting","href":"/api-reference/ip-whitelisting"},{"title":"Rate Limiting","href":"/api-reference/rate-limiting"},{"title":"Errors","description":"Standard error codes and response format","href":"/api-reference/errors"}]},{"group":"Customers","icon":"users","expanded":false,"pages":[{"title":"List Customers","openapi":"GET /customers","href":"/api-reference/endpoint/customers/list"},{"title":"Get Customer","description":"Retrieve one customer by ID, including tags, addresses, additional data fields, and subscription status.","openapi":"GET /customers/{id}","href":"/api-reference/endpoint/customers/get"},{"title":"Create Customer","openapi":"POST /customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer","openapi":"PUT /customers/{id}","href":"/api-reference/endpoint/customers/update"},{"title":"Delete Customer","openapi":"DELETE /customers/{id}","href":"/api-reference/endpoint/customers/delete"}]},{"group":"Loyalty (bitLogin)","icon":"coins","expanded":false,"pages":[{"title":"Get Loyalty Integration","openapi":"GET /bitlogin/api/open/v1/loyalty/integration","href":"/api-reference/endpoint/loyalty-bitlogin/integration-get"},{"title":"Set Loyalty Integration","openapi":"POST /bitlogin/api/open/v1/loyalty/integration","href":"/api-reference/endpoint/loyalty-bitlogin/integration-set"},{"title":"Get Point Conversion","openapi":"GET /bitlogin/api/open/v1/loyalty/point-conversion","href":"/api-reference/endpoint/loyalty-bitlogin/point-conversion-get"},{"title":"Set Point Conversion","openapi":"POST /bitlogin/api/open/v1/loyalty/point-conversion","href":"/api-reference/endpoint/loyalty-bitlogin/point-conversion-set"},{"title":"List Reward Options","openapi":"GET /bitlogin/api/open/v1/loyalty/reward-options","href":"/api-reference/endpoint/loyalty-bitlogin/reward-options-list"},{"title":"Create Reward Option","openapi":"POST /bitlogin/api/open/v1/loyalty/reward-options","href":"/api-reference/endpoint/loyalty-bitlogin/reward-options-create"},{"title":"Get Reward Option","openapi":"GET /bitlogin/api/open/v1/loyalty/reward-options/{id}","href":"/api-reference/endpoint/loyalty-bitlogin/reward-options-get"},{"title":"Update Reward Option","openapi":"PUT /bitlogin/api/open/v1/loyalty/reward-options/{id}","href":"/api-reference/endpoint/loyalty-bitlogin/reward-options-update"},{"title":"Delete Reward Option","openapi":"DELETE /bitlogin/api/open/v1/loyalty/reward-options/{id}","href":"/api-reference/endpoint/loyalty-bitlogin/reward-options-delete"}]},{"group":"Loyalty (Customer)","icon":"gift","expanded":false,"pages":[{"title":"Loyalty API Overview","href":"/api-reference/endpoint/loyalty-customers/overview"},{"title":"Get Loyalty Reward Options","openapi":"GET /customer/api/open/v1/loyalty/reward-options","href":"/api-reference/endpoint/loyalty-customers/reward-options"},{"title":"Get Loyalty Wallet","openapi":"GET /customer/api/open/v1/loyalty/customers/{customerId}/wallet","href":"/api-reference/endpoint/loyalty-customers/wallet"},{"title":"Adjust Loyalty Points","openapi":"POST /customer/api/open/v1/loyalty/customers/{customerId}/points/adjust","href":"/api-reference/endpoint/loyalty-customers/points-adjust"},{"title":"Redeem Loyalty Reward","openapi":"POST /customer/api/open/v1/loyalty/customers/{customerId}/redeem","href":"/api-reference/endpoint/loyalty-customers/redeem"},{"title":"Get Customer Redemptions","openapi":"GET /customer/api/open/v1/loyalty/customers/{customerId}/redemptions","href":"/api-reference/endpoint/loyalty-customers/redemptions"},{"title":"Get Redeemed Points Summary","openapi":"GET /customer/api/open/v1/loyalty/customers/{customerId}/redemptions/summary","href":"/api-reference/endpoint/loyalty-customers/redeemed-summary"},{"title":"Get Point History","openapi":"GET /customer/api/open/v1/loyalty/customers/{customerId}/history","href":"/api-reference/endpoint/loyalty-customers/point-history"},{"title":"Get Customer Timeline","openapi":"GET /customer/api/open/v1/loyalty/customers/{customerId}/timeline","href":"/api-reference/endpoint/loyalty-customers/timeline"},{"title":"Reward Redemption Summary List","openapi":"GET /customer/api/open/v1/loyalty/rewards/redemptions/summary","href":"/api-reference/endpoint/loyalty-customers/redeem-summary-list"},{"title":"Reward Redemption Summary Detail","openapi":"GET /customer/api/open/v1/loyalty/rewards/{rewardOptionId}/redemptions/summary","href":"/api-reference/endpoint/loyalty-customers/redeem-summary-detail"},{"title":"Reward Redeemers","openapi":"GET /customer/api/open/v1/loyalty/rewards/{rewardOptionId}/redeemers","href":"/api-reference/endpoint/loyalty-customers/redeemers"}]},{"group":"Orders","icon":"receipt","expanded":false,"pages":[{"title":"List Orders","openapi":"GET /orders","href":"/api-reference/endpoint/orders/list"},{"title":"Get Order","openapi":"GET /orders/{id}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Order Shipping","openapi":"GET /orders/{id}/shipping","href":"/api-reference/endpoint/orders/get-shipping"},{"title":"Create Order","openapi":"POST /orders","href":"/api-reference/endpoint/orders/create"},{"title":"Update Order","openapi":"PUT /orders/{id}","href":"/api-reference/endpoint/orders/update"}]},{"group":"Shipping","icon":"truck","expanded":false,"pages":[{"title":"Shipping overview","href":"/api-reference/endpoint/shipping/overview"},{"group":"Store Locations","icon":"location-dot","expanded":false,"pages":[{"title":"List store locations","openapi":"GET /shipping/store-locations","href":"/api-reference/endpoint/shipping/list-store-locations"},{"title":"Get store location","openapi":"GET /shipping/store-locations/{id}","href":"/api-reference/endpoint/shipping/get-store-location"},{"title":"Create store location","openapi":"POST /shipping/store-locations","href":"/api-reference/endpoint/shipping/create-store-location"},{"title":"Update store location","openapi":"PUT /shipping/store-locations/{id}","href":"/api-reference/endpoint/shipping/update-store-location"},{"title":"Delete store location","openapi":"DELETE /shipping/store-locations/{id}","href":"/api-reference/endpoint/shipping/delete-store-location"}]},{"group":"Providers","icon":"truck-fast","expanded":false,"pages":[{"title":"List shipping providers","openapi":"GET /shipping/providers","href":"/api-reference/endpoint/shipping/list-providers"},{"title":"Get provider services","openapi":"GET /shipping/providers/{provider}/services","href":"/api-reference/endpoint/shipping/get-provider-services"}]},{"group":"Coverage","icon":"map-location-dot","expanded":false,"pages":[{"title":"List provinces","openapi":"GET /shipping/coverage/provinces","href":"/api-reference/endpoint/shipping/coverage-provinces"},{"title":"List cities","openapi":"GET /shipping/coverage/cities","href":"/api-reference/endpoint/shipping/coverage-cities"},{"title":"List districts","openapi":"GET /shipping/coverage/districts","href":"/api-reference/endpoint/shipping/coverage-districts"},{"title":"List sub-districts","openapi":"GET /shipping/coverage/sub-districts","href":"/api-reference/endpoint/shipping/coverage-sub-districts"}]},{"title":"Calculate shipping fee","openapi":"POST /shipping/calculate-fee","href":"/api-reference/endpoint/shipping/calculate-fee"},{"group":"Shipments","icon":"boxes-stacked","expanded":false,"pages":[{"title":"List shipments","openapi":"GET /shipping/shipments","href":"/api-reference/endpoint/shipping/list-shipments"},{"title":"Get shipment","openapi":"GET /shipping/shipments/{id}","href":"/api-reference/endpoint/shipping/get-shipment"},{"title":"Create shipment","openapi":"POST /shipping/shipments","href":"/api-reference/endpoint/shipping/create-shipment"},{"title":"Update shipment","openapi":"PATCH /shipping/shipments/{id}","href":"/api-reference/endpoint/shipping/update-shipment"},{"title":"Cancel shipment","openapi":"POST /shipping/shipments/{id}/cancel","href":"/api-reference/endpoint/shipping/cancel-shipment"},{"title":"Get shipment tracking","openapi":"GET /shipping/shipments/{id}/tracking","href":"/api-reference/endpoint/shipping/get-shipment-tracking"}]}]},{"group":"Products","icon":"box","expanded":false,"pages":[{"title":"List Products","openapi":"GET /products","href":"/api-reference/endpoint/products/list"},{"title":"Get Product","openapi":"GET /products/{id}","href":"/api-reference/endpoint/products/get"},{"title":"Create Product","openapi":"POST /products","href":"/api-reference/endpoint/products/create"},{"title":"Update Product","openapi":"PUT /products/{id}","href":"/api-reference/endpoint/products/update"},{"title":"Delete Product","openapi":"DELETE /products/{id}","href":"/api-reference/endpoint/products/delete"}]},{"group":"Messaging","icon":"comments","expanded":false,"pages":[{"title":"Send Message","openapi":"POST /messages/send","href":"/api-reference/endpoint/messages/send"},{"title":"Send Template Message","openapi":"POST /messages/send-template","href":"/api-reference/endpoint/messages/send-template"},{"title":"List Request History","openapi":"GET /messages/requests","href":"/api-reference/endpoint/messages/requests"},{"title":"Get Message","openapi":"GET /messages/{messageId}","href":"/api-reference/endpoint/messages/get"}]},{"group":"Analytics","icon":"chart-column","expanded":false,"pages":[{"title":"Overview","href":"/api-reference/endpoint/analytics/overview"},{"title":"Get Agent Analytics","openapi":"GET /analytics/agents","href":"/api-reference/endpoint/analytics/agents"}]},{"group":"Webhooks","icon":"webhook","expanded":false,"pages":[{"title":"Webhooks Overview","href":"/api-reference/webhooks/overview"},{"title":"Webhook Security","href":"/api-reference/webhooks/security"},{"title":"Webhook Events","href":"/api-reference/webhooks/events"},{"title":"Best Practices","href":"/api-reference/webhooks/best-practices"}]}]}]}]},"basePath":"","title":"List Customers - bitbybit","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}