{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Letterby API","colors":{"primary":"#333333","light":"#f4f4f4","dark":"#333333"},"favicon":"https://mintcdn.com/waitless/V-P4VywQb9uyGifW/favicon.svg?fit=max\u0026auto=format\u0026n=V-P4VywQb9uyGifW\u0026q=85\u0026s=ba93851af0a06f14011a442d809c5fb7","logo":{"light":"https://mintcdn.com/waitless/V-P4VywQb9uyGifW/logo/light.svg?fit=max\u0026auto=format\u0026n=V-P4VywQb9uyGifW\u0026q=85\u0026s=81255b741986546466da6bb889739d7c","dark":"https://mintcdn.com/waitless/V-P4VywQb9uyGifW/logo/dark.svg?fit=max\u0026auto=format\u0026n=V-P4VywQb9uyGifW\u0026q=85\u0026s=94c783af4c3c77b4c7b8f983f8459d78"},"navbar":{"links":[{"label":"Support","href":"mailto:hi@letterby.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://letterby.com/admin/lists"}},"footer":{"socials":{"x":"https://x.com/waitless__","linkedin":"https://www.linkedin.com/company/waitless1"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","href":"https://docs.letterby.com","icon":"book-open-cover"},{"anchor":"Updates","href":"https://letterby.com/updates","icon":"newspaper"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"waitless","hasAudioNarration":false,"actualSubdomain":"waitless","customDomains":["docs.letterby.com"],"gitSource":{"type":"github","owner":"evernomic","repo":"letterby","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21a73d089b5a0f9ac10f99","collectionId":"b6161a5a-a6a0-4889-b8cf-f3f704b9a2d7","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21a73d089b5a0f9ac10f99:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Actions","count":5},{"language":"default","tag":"Audiences","count":5},{"language":"default","tag":"Contacts","count":5},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Lists","count":4},{"language":"default","tag":"Tutorials","count":3},{"language":"default","tag":"Essentials","count":2},{"language":"default","tag":"API Documentation","count":1},{"language":"default","tag":"Authentication","count":1}]},"assistantConfig":{},"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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/contacts-list","slug":"/api-reference/endpoint/contacts-list","pageMetadata":{"title":"List Contacts","openapi":"GET /contacts","description":"Returns contacts from the system that the user has access to","href":"/api-reference/endpoint/contacts-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: \"Returns contacts from the system that the user has access to\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Contacts","openapi":"GET /contacts","description":"Returns contacts from the system that the user has access to","href":"/api-reference/endpoint/contacts-list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Returns contacts from the system that the user has access to","parameters":["47eeada4-eb5c-46b9-8803-230ad8b1cf6c","262f411d-221e-41a7-86d1-32c7483802fc","e9067159-682b-46b3-a023-60a9f229077c","86610522-a8ca-4d82-b91f-80664aae3361","3687ea11-5556-446a-884d-fcc4bb4527d6","6734680a-534b-4ebe-a48b-af516e0772c3","8de7a9d7-c6fe-4ef4-8ce4-46907b134840","bebc7b21-909e-452d-a63d-9ba57c249065","9e127f92-6c24-4a51-b77c-e698e954a1f3","a4bcf554-38cf-4719-8583-404c6d54fe0e","347ebcfc-0db8-498e-bb2d-52cad041efc5","7afc7ca8-2b7b-4537-b5d8-53e16006ac66","18579dab-7b7a-4457-b67f-e839715c004b","8d3c565a-1125-419b-8831-9aa99d7ab1c6","b9282be0-aa54-4082-9907-2ac284146e26","4e30dc8e-b12b-4c87-b721-06c083f11881","df9e44f6-aa95-4069-a6f5-42eea4d8a090","6b44b03e-67d0-4c71-a778-1c43c0c2bc37","4f023b41-b751-459c-905b-a314b5b7c561"],"responses":{"200":"7c67db46-b8c7-47ef-9188-8516241b3276","400":"81ed0c1f-bfcb-43b1-a1e4-25e17c233856","401":"2b9a0bc7-d132-4f5e-a4b2-bf8860bebb5d"},"method":"get","type":"path","servers":["2620bb65-8160-4d96-9e07-4dc862c6cfd7"],"security":["74121f73-f877-4ca7-9815-f400b2c4e3db"],"path":"/contacts","baseUrlOptions":["https://letterby.com/api/v4"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"47eeada4-eb5c-46b9-8803-230ad8b1cf6c":{"name":"listId","in":"query","description":"Filter contacts by list ID","required":true,"schema":{"type":"string","isRequired":true,"description":"Filter contacts by list ID","uniqueKey":"","typeLabel":"string"}},"262f411d-221e-41a7-86d1-32c7483802fc":{"name":"limit","in":"query","description":"The maximum number of results to return (default and max: 20000)","schema":{"type":"integer","format":"int32","description":"The maximum number of results to return (default and max: 20000)","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"e9067159-682b-46b3-a023-60a9f229077c":{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","format":"int32","description":"Page number for pagination","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"86610522-a8ca-4d82-b91f-80664aae3361":{"name":"sort","in":"query","description":"Field to sort by (default sorts by points and createdAt)","schema":{"type":"string","enum":["points","createdAt","email","firstName","lastName","position"],"description":"Field to sort by (default sorts by points and createdAt)","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"3687ea11-5556-446a-884d-fcc4bb4527d6":{"name":"order","in":"query","description":"Sort order (default: desc)","schema":{"type":"string","enum":["asc","desc"],"description":"Sort order (default: desc)","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"6734680a-534b-4ebe-a48b-af516e0772c3":{"name":"email","in":"query","description":"Filter contacts by email (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by email (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"8de7a9d7-c6fe-4ef4-8ce4-46907b134840":{"name":"firstName","in":"query","description":"Filter contacts by first name (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by first name (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"bebc7b21-909e-452d-a63d-9ba57c249065":{"name":"lastName","in":"query","description":"Filter contacts by last name (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by last name (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"9e127f92-6c24-4a51-b77c-e698e954a1f3":{"name":"phoneNumber","in":"query","description":"Filter contacts by phone number (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by phone number (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"a4bcf554-38cf-4719-8583-404c6d54fe0e":{"name":"name","in":"query","description":"Filter contacts by full name (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by full name (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"347ebcfc-0db8-498e-bb2d-52cad041efc5":{"name":"company","in":"query","description":"Filter contacts by company (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by company (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"7afc7ca8-2b7b-4537-b5d8-53e16006ac66":{"name":"country","in":"query","description":"Filter contacts by country (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by country (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"18579dab-7b7a-4457-b67f-e839715c004b":{"name":"city","in":"query","description":"Filter contacts by city (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by city (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"8d3c565a-1125-419b-8831-9aa99d7ab1c6":{"name":"instagram","in":"query","description":"Filter contacts by Instagram handle (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by Instagram handle (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"b9282be0-aa54-4082-9907-2ac284146e26":{"name":"twitter","in":"query","description":"Filter contacts by Twitter handle (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by Twitter handle (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"4e30dc8e-b12b-4c87-b721-06c083f11881":{"name":"website","in":"query","description":"Filter contacts by website URL (partial match, case-insensitive)","schema":{"type":"string","description":"Filter contacts by website URL (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"}},"df9e44f6-aa95-4069-a6f5-42eea4d8a090":{"name":"isVerified","in":"query","description":"Filter contacts by verification status","schema":{"type":"boolean","description":"Filter contacts by verification status","uniqueKey":"","typeLabel":"boolean"}},"6b44b03e-67d0-4c71-a778-1c43c0c2bc37":{"name":"unsubscribed","in":"query","description":"Filter contacts by subscription status","schema":{"type":"boolean","description":"Filter contacts by subscription status","uniqueKey":"","typeLabel":"boolean"}},"4f023b41-b751-459c-905b-a314b5b7c561":{"name":"isGDPR","in":"query","description":"Filter contacts by GDPR consent status","schema":{"type":"boolean","description":"Filter contacts by GDPR consent status","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"7c67db46-b8c7-47ef-9188-8516241b3276":{"description":"Contacts response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the contact","uniqueKey":"data.contacts.items.[INDEX].id","typeLabel":"string"},"email":{"type":"string","description":"Email address of the contact","uniqueKey":"data.contacts.items.[INDEX].email","typeLabel":"string"},"firstName":{"type":"string","description":"First name of the contact","uniqueKey":"data.contacts.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the contact","uniqueKey":"data.contacts.items.[INDEX].lastName","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Phone number of the contact","uniqueKey":"data.contacts.items.[INDEX].phoneNumber","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"When the contact was created","uniqueKey":"data.contacts.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"points":{"type":"integer","description":"Points accumulated by the contact","uniqueKey":"data.contacts.items.[INDEX].points","typeLabel":"integer"},"referrals":{"type":"integer","description":"Number of referrals by the contact","uniqueKey":"data.contacts.items.[INDEX].referrals","typeLabel":"integer"},"listId":{"type":"string","description":"ID of the list this contact belongs to","uniqueKey":"data.contacts.items.[INDEX].listId","typeLabel":"string"},"isVerified":{"type":"boolean","description":"Whether the contact is verified","uniqueKey":"data.contacts.items.[INDEX].isVerified","typeLabel":"boolean"},"unsubscribed":{"type":"boolean","description":"Whether the contact has unsubscribed","uniqueKey":"data.contacts.items.[INDEX].unsubscribed","typeLabel":"boolean"},"data":{"type":"object","description":"Custom data associated with the contact","uniqueKey":"data.contacts.items.[INDEX].data","typeLabel":"object"},"address":{"type":"string","description":"Contact's address","uniqueKey":"data.contacts.items.[INDEX].address","typeLabel":"string"},"isGDPR":{"type":"boolean","description":"Whether the contact has GDPR consent","uniqueKey":"data.contacts.items.[INDEX].isGDPR","typeLabel":"boolean"},"name":{"type":"string","description":"Full name of the contact","uniqueKey":"data.contacts.items.[INDEX].name","typeLabel":"string"},"instagram":{"type":"string","description":"Instagram handle","uniqueKey":"data.contacts.items.[INDEX].instagram","typeLabel":"string"},"twitter":{"type":"string","description":"Twitter handle","uniqueKey":"data.contacts.items.[INDEX].twitter","typeLabel":"string"},"website":{"type":"string","description":"Personal website URL","uniqueKey":"data.contacts.items.[INDEX].website","typeLabel":"string"},"company":{"type":"string","description":"Company name","uniqueKey":"data.contacts.items.[INDEX].company","typeLabel":"string"},"country":{"type":"string","description":"Country of residence","uniqueKey":"data.contacts.items.[INDEX].country","typeLabel":"string"},"city":{"type":"string","description":"City of residence","uniqueKey":"data.contacts.items.[INDEX].city","typeLabel":"string"},"list":{"type":"object","description":"Associated list information","properties":{"id":{"type":"string","description":"List ID","uniqueKey":"data.contacts.items.[INDEX].list.id","typeLabel":"string"},"name":{"type":"string","description":"List name","uniqueKey":"data.contacts.items.[INDEX].list.name","typeLabel":"string"},"url":{"type":"string","description":"List URL identifier","uniqueKey":"data.contacts.items.[INDEX].list.url","typeLabel":"string"},"mode":{"type":"string","description":"List mode","uniqueKey":"data.contacts.items.[INDEX].list.mode","typeLabel":"string"},"referrals":{"type":"boolean","description":"Whether referrals are enabled","uniqueKey":"data.contacts.items.[INDEX].list.referrals","typeLabel":"boolean"},"color":{"type":"string","description":"List primary color","uniqueKey":"data.contacts.items.[INDEX].list.color","typeLabel":"string"},"title":{"type":"string","description":"List title","uniqueKey":"data.contacts.items.[INDEX].list.title","typeLabel":"string"},"desc":{"type":"string","description":"List description","uniqueKey":"data.contacts.items.[INDEX].list.desc","typeLabel":"string"}},"uniqueKey":"data.contacts.items.[INDEX].list","typeLabel":"object"},"audiences":{"type":"array","description":"Audiences this contact belongs to","uniqueKey":"data.contacts.items.[INDEX].audiences","typeLabel":"array"},"referralLink":{"type":"string","description":"Contact's referral link","uniqueKey":"data.contacts.items.[INDEX].referralLink","typeLabel":"string"},"privateLink":{"type":"string","description":"Contact's private subscriber page URL","uniqueKey":"data.contacts.items.[INDEX].privateLink","typeLabel":"string"}},"uniqueKey":"data.contacts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.contacts","typeLabel":"object[]"},"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of contacts","uniqueKey":"data.pagination.total","typeLabel":"integer"},"pages":{"type":"integer","description":"Total number of pages","uniqueKey":"data.pagination.pages","typeLabel":"integer"},"currentPage":{"type":"integer","description":"Current page number","uniqueKey":"data.pagination.currentPage","typeLabel":"integer"},"perPage":{"type":"integer","description":"Number of items per page","uniqueKey":"data.pagination.perPage","typeLabel":"integer"}},"uniqueKey":"data.pagination","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"contacts":[{"id":"\u003cstring>","email":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","phoneNumber":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","points":123,"referrals":123,"listId":"\u003cstring>","isVerified":true,"unsubscribed":true,"data":{},"address":"\u003cstring>","isGDPR":true,"name":"\u003cstring>","instagram":"\u003cstring>","twitter":"\u003cstring>","website":"\u003cstring>","company":"\u003cstring>","country":"\u003cstring>","city":"\u003cstring>","list":{"id":"\u003cstring>","name":"\u003cstring>","url":"\u003cstring>","mode":"\u003cstring>","referrals":true,"color":"\u003cstring>","title":"\u003cstring>","desc":"\u003cstring>"},"audiences":"\u003carray>","referralLink":"\u003cstring>","privateLink":"\u003cstring>"}],"pagination":{"total":123,"pages":123,"currentPage":123,"perPage":123}}}}},"exampleType":"generated"}},"exampleType":"generated"},"81ed0c1f-bfcb-43b1-a1e4-25e17c233856":{"description":"Bad request","content":{"application/json":{"schema":{"required":["error","message"],"type":"object","properties":{"error":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"error","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"2b9a0bc7-d132-4f5e-a4b2-bf8860bebb5d":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"required":["error","message"],"type":"object","properties":{"error":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"error","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"74121f73-f877-4ca7-9815-f400b2c4e3db":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"apiKey","description":"API key to authorize requests","scopes":[]}}},"servers":{"2620bb65-8160-4d96-9e07-4dc862c6cfd7":{"url":"https://letterby.com/api/v4"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"apiKey","description":"API key to authorize requests","scopes":[]},"schema":{"title":"apiKey","type":"string","description":"API key to authorize requests","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"apiKey"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"waitless","siteName":"Letterby API","title":"List Contacts - Letterby API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-26T13:08:54.801Z","originalFileLocation":"api-reference/endpoint/contacts-list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns contacts from the system that the user has access to\">\u003cmeta data-mint-head name=\"application-name\" content=\"Letterby API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/waitless/Lk_vIhCJULwv-nsV/_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/waitless/Lk_vIhCJULwv-nsV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/waitless/Lk_vIhCJULwv-nsV/_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/waitless/Lk_vIhCJULwv-nsV/_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/waitless/Lk_vIhCJULwv-nsV/_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/waitless/Lk_vIhCJULwv-nsV/_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/waitless/Lk_vIhCJULwv-nsV/_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/waitless/Lk_vIhCJULwv-nsV/_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/waitless/Lk_vIhCJULwv-nsV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Contacts - Letterby API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns contacts from the system that the user has access to\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Letterby API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.letterby.com/api-reference/endpoint/contacts-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://waitless.mintlify.app/_mintlify/api/og/v2?division=Contacts\u0026amp;title=List+Contacts\u0026amp;description=Returns+contacts+from+the+system+that+the+user+has+access+to\u0026amp;theme=5546e182715a4fd0b0a6a796\u0026amp;signature=6c2f056d36fc47382a8c82cd7a4bd7bf154f11c4d687e03e6041a34d4787cf44\">\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 Contacts - Letterby API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns contacts from the system that the user has access to\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://waitless.mintlify.app/_mintlify/api/og/v2?division=Contacts\u0026amp;title=List+Contacts\u0026amp;description=Returns+contacts+from+the+system+that+the+user+has+access+to\u0026amp;theme=5546e182715a4fd0b0a6a796\u0026amp;signature=6c2f056d36fc47382a8c82cd7a4bd7bf154f11c4d687e03e6041a34d4787cf44\">\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/waitless/Lk_vIhCJULwv-nsV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Letterby API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#333333\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.letterby.com/api-reference/endpoint/contacts-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/contacts-list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.letterby.com/#organization\",\"name\":\"Letterby API\",\"url\":\"https://docs.letterby.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/waitless/V-P4VywQb9uyGifW/logo/light.svg?fit=max\u0026auto=format\u0026n=V-P4VywQb9uyGifW\u0026q=85\u0026s=81255b741986546466da6bb889739d7c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.letterby.com#website\",\"name\":\"Letterby API\",\"url\":\"https://docs.letterby.com\",\"publisher\":{\"@id\":\"https://docs.letterby.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.letterby.com/api-reference/endpoint/contacts-list#webpage\",\"url\":\"https://docs.letterby.com/api-reference/endpoint/contacts-list\",\"name\":\"List Contacts\",\"description\":\"Returns contacts from the system that the user has access to\",\"dateModified\":\"2025-11-26T13:08:54.801Z\",\"isPartOf\":{\"@id\":\"https://docs.letterby.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.letterby.com/api-reference/endpoint/contacts-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.letterby.com/api-reference/endpoint/contacts-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Contacts\",\"item\":\"https://docs.letterby.com/api-reference/endpoint/contact-create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Contacts\",\"item\":\"https://docs.letterby.com/api-reference/endpoint/contacts-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.letterby.com/api-reference/endpoint/contacts-list#apireference\",\"headline\":\"List Contacts\",\"name\":\"List Contacts\",\"description\":\"Returns contacts from the system that the user has access to\",\"url\":\"https://docs.letterby.com/api-reference/endpoint/contacts-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.letterby.com/api-reference/endpoint/contacts-list#webpage\"},\"dateModified\":\"2025-11-26T13:08:54.801Z\",\"publisher\":{\"@id\":\"https://docs.letterby.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.letterby.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Letterby API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Letterby API","nav":{"global":{"anchors":[{"anchor":"Documentation","href":"https://docs.letterby.com","icon":"book-open-cover"},{"anchor":"Updates","href":"https://letterby.com/updates","icon":"newspaper"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Contacts","pages":[{"title":"Create Contact","openapi":"POST /contacts","href":"/api-reference/endpoint/contact-create"},{"title":"Retrieve Contact","openapi":"GET /contacts/{id}","href":"/api-reference/endpoint/contact-retrieve"},{"title":"Update Contact","openapi":"PATCH /contacts/{id}","href":"/api-reference/endpoint/contact-update"},{"title":"Delete Contact","openapi":"DELETE /contacts/{id}","description":"Deletes a contact by ID","href":"/api-reference/endpoint/contact-delete"},{"title":"List Contacts","openapi":"GET /contacts","href":"/api-reference/endpoint/contacts-list"}]},{"group":"Actions","pages":[{"title":"Create Action","openapi":"POST /actions","description":"Creates a new action","href":"/api-reference/endpoint/action-create"},{"title":"Retrieve Action","openapi":"GET /actions/{id}","href":"/api-reference/endpoint/action-retrieve"},{"title":"Update Action","openapi":"PATCH /actions/{id}","href":"/api-reference/endpoint/action-update"},{"title":"Delete Action","openapi":"DELETE /actions/{id}","href":"/api-reference/endpoint/action-delete"},{"title":"List Actions","openapi":"GET /actions","href":"/api-reference/endpoint/actions-list"}]},{"group":"Audiences","pages":[{"title":"Create Audience","openapi":"POST /audiences","href":"/api-reference/endpoint/audience-create"},{"title":"Retrieve Audience","openapi":"GET /audiences/{id}","href":"/api-reference/endpoint/audience-retrieve"},{"title":"Update Audience","openapi":"PATCH /audiences/{id}","href":"/api-reference/endpoint/audience-update"},{"title":"Delete Audience","openapi":"DELETE /audiences/{id}","href":"/api-reference/endpoint/audience-delete"},{"title":"List Audiences","openapi":"GET /audiences","href":"/api-reference/endpoint/audiences-list"}]},{"group":"Lists","pages":[{"title":"Create List","openapi":"POST /lists","href":"/api-reference/endpoint/list-create"},{"title":"Retrieve List","openapi":"GET /lists/{id}","href":"/api-reference/endpoint/list-retrieve"},{"title":"Delete List","openapi":"DELETE /lists/{id}","href":"/api-reference/endpoint/list-delete"},{"title":"List All Lists","openapi":"GET /lists","href":"/api-reference/endpoint/lists-list"}]}]},{"tab":"Essentials","pages":[{"title":"Essentials","href":"/essentials/code"}]}]},"basePath":"","title":"List Contacts - Letterby API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}