Request Rate: ~100 requests per 5 seconds per project (same as other lead APIs).
Heavy use of this endpoint (especially with masked=false) can be expensive; cache results when possible.
Query Parameters
string
MongoDB ObjectId of the lead (required if not using referenceId)
string
External reference ID (requires projectId and processId)
string
Required when using referenceId
string
Required when using referenceId
boolean
default:"false"
If true, masks phone number (all but last 4 digits)
Response
boolean
Indicates if the request was successful
object
The lead object with activities
Show Lead Properties
string
MongoDB ObjectId of the lead
string
Lead’s name
string
Phone number
string
Email address
string
Project ID
string
Process ID
string
External reference ID
string
Current state of the lead
string
Last disposition
object
Lead metadata
string
ISO 8601 timestamp of creation
string
ISO 8601 timestamp of last update
array
Array of activity objects
Error Responses
400 Bad Request
Missing identifier
Returned when neither leadId nor referenceId is provided.
Example:
{ "success": false, "error": "Either leadId or referenceId is required"}
Missing projectId/processId with referenceId
Returned when referenceId is provided without both projectId and processId.
Example:
{ "success": false, "error": "projectId and processId are required when using referenceId"}
404 Not Found
Returned when no lead matches the provided identifiers.
Examples:
{ "success": false, "error": "Lead with ID <leadId> not found" }{ "success": false, "error": "Lead with referenceId <referenceId> not found" }
429 Too Many Requests
Returned when project-level rate limits are exceeded for this endpoint.
Recommended behavior:
Back off and retry later with exponential backoff.
Avoid hot-loop polling; cache results on your side when possible.
500 Internal Server Error
Unexpected server-side error.
Safe to retry with backoff; if it persists, contact support with request details.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Uservox Docs","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://uservox.ai/home/images/logo/logo_dark_lg.png","dark":"https://uservox.ai/home/images/logo/logo_dark_lg.png"},"favicon":"https://mintcdn.com/uservox/LCcwBNBHTHdM9mfQ/favicon.svg?fit=max\u0026auto=format\u0026n=LCcwBNBHTHdM9mfQ\u0026q=85\u0026s=25ae4d037a876e965deed25f94edb9bb","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://crm.uservox.ai/api/v1"}},"navbar":{"links":[{"href":"mailto:hi@mintlify.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.uservox.ai"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Uservox","icon":"globe","href":"https://uservox.ai"},{"anchor":"Dashboard","icon":"rectangle-terminal","href":"https://app.uservox.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"uservox","hasAudioNarration":false,"actualSubdomain":"uservox","customDomains":["docs.uservox.ai"],"gitSource":{"type":"github","owner":"girnarai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aeace110e439ad241858ad5","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Guides","count":56},{"language":"default","tag":"API Reference","count":12},{"language":"default","tag":"Process","count":12},{"language":"default","tag":"Leads","count":11},{"language":"default","tag":"Agent","count":10},{"language":"default","tag":"API Integration","count":8},{"language":"default","tag":"Settings","count":7},{"language":"default","tag":"WhatsApp","count":5},{"language":"default","tag":"Essentials","count":4},{"language":"default","tag":"Activities","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"select option{background-color:var(--background-primary)!important;color:var(--text-primary)!important}.dark select option{background-color:#1a1a1a!important;color:#ffffff!important}#api-playground-input select option{background-color:var(--background-primary)!important;color:var(--text-primary)!important}select{color-scheme:dark}.dark select{background-color:#2d2d2d;color:#ffffff}.dark select option{background-color:#2d2d2d;color:#ffffff}"}],"page":{"pagePath":"api-reference/get-lead","slug":"/api-reference/get-lead","pageMetadata":{"title":"Get Lead","api":"GET /leads/get","description":"Retrieve a single lead with all of its call activities through the Uservox API, with masked or unmasked fields and rate limits explained.","href":"/api-reference/get-lead"},"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 single lead with all of its call activities through the Uservox API, with masked or unmasked fields and rate limits explained.\"\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={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Rate Limits:`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Request Rate: ~100 requests per 5 seconds per project (same as other lead APIs).`}),`\n`,_jsxs(_components.li,{children:[`Heavy use of this endpoint (especially with `,_jsx(_components.code,{children:`masked=false`}),`) can be expensive; cache results when possible.`]}),`\n`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query Parameters`}),`\n`,_jsx(ParamField,{query:`leadId`,type:`string`,id:`param-lead-id`,children:_jsx(_components.p,{children:`MongoDB ObjectId of the lead (required if not using referenceId)`})}),`\n`,_jsx(ParamField,{query:`referenceId`,type:`string`,id:`param-reference-id`,children:_jsx(_components.p,{children:`External reference ID (requires projectId and processId)`})}),`\n`,_jsx(ParamField,{query:`projectId`,type:`string`,id:`param-project-id`,children:_jsx(_components.p,{children:`Required when using referenceId`})}),`\n`,_jsx(ParamField,{query:`processId`,type:`string`,id:`param-process-id`,children:_jsx(_components.p,{children:`Required when using referenceId`})}),`\n`,_jsx(ParamField,{query:`masked`,type:`boolean`,default:`false`,id:`param-masked`,children:_jsxs(_components.p,{children:[`If `,_jsx(_components.code,{children:`true`}),`, masks phone number (all but last 4 digits)`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Indicates if the request was successful`})}),`\n`,_jsxs(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:[_jsx(_components.p,{children:`The lead object with activities`}),_jsxs(Expandable,{title:`Lead Properties`,children:[_jsx(ResponseField,{name:`_id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`MongoDB ObjectId of the lead`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`Lead’s name`})}),_jsx(ResponseField,{name:`phone`,type:`string`,id:`param-phone`,children:_jsx(_components.p,{children:`Phone number`})}),_jsx(ResponseField,{name:`email`,type:`string`,id:`param-email`,children:_jsx(_components.p,{children:`Email address`})}),_jsx(ResponseField,{name:`projectId`,type:`string`,id:`param-project-id-1`,children:_jsx(_components.p,{children:`Project ID`})}),_jsx(ResponseField,{name:`processId`,type:`string`,id:`param-process-id-1`,children:_jsx(_components.p,{children:`Process ID`})}),_jsx(ResponseField,{name:`referenceId`,type:`string`,id:`param-reference-id-1`,children:_jsx(_components.p,{children:`External reference ID`})}),_jsx(ResponseField,{name:`currentState`,type:`string`,id:`param-current-state`,children:_jsx(_components.p,{children:`Current state of the lead`})}),_jsx(ResponseField,{name:`lastDisposition`,type:`string`,id:`param-last-disposition`,children:_jsx(_components.p,{children:`Last disposition`})}),_jsx(ResponseField,{name:`metadata`,type:`object`,id:`param-metadata`,children:_jsx(_components.p,{children:`Lead metadata`})}),_jsx(ResponseField,{name:`createdAt`,type:`string`,id:`param-created-at`,children:_jsx(_components.p,{children:`ISO 8601 timestamp of creation`})}),_jsx(ResponseField,{name:`updatedAt`,type:`string`,id:`param-updated-at`,children:_jsx(_components.p,{children:`ISO 8601 timestamp of last update`})}),_jsx(ResponseField,{name:`activities`,type:`array`,id:`param-activities`,children:_jsx(_components.p,{children:`Array of activity objects`})})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error Responses`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`400 Bad Request`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Missing identifier`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Returned when neither `,_jsx(_components.code,{children:`leadId`}),` nor `,_jsx(_components.code,{children:`referenceId`}),` is provided.`]}),`\n`,_jsxs(_components.li,{children:[`Example:`,`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Either leadId or referenceId is required\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Missing projectId/processId with referenceId`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Returned when `,_jsx(_components.code,{children:`referenceId`}),` is provided without both `,_jsx(_components.code,{children:`projectId`}),` and `,_jsx(_components.code,{children:`processId`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Example:`,`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"projectId and processId are required when using referenceId\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`]}),`\n`]}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`404 Not Found`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Returned when no lead matches the provided identifiers.`}),`\n`,_jsxs(_components.li,{children:[`Examples:`,`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Lead with ID \u003cleadId> not found\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Lead with referenceId \u003creferenceId> not found\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`429 Too Many Requests`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Returned when project-level rate limits are exceeded for this endpoint.`}),`\n`,_jsxs(_components.li,{children:[`Recommended behavior:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Back off and retry later with exponential backoff.`}),`\n`,_jsx(_components.li,{children:`Avoid hot-loop polling; cache results on your side when possible.`}),`\n`]}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`500 Internal Server Error`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Unexpected server-side error.`}),`\n`,_jsx(_components.li,{children:`Safe to retry with backoff; if it persists, contact support with request details.`}),`\n`]}),`\n`]}),`\n`]})]})}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":"Get Lead","api":"GET /leads/get","description":"Retrieve a single lead with all of its call activities through the Uservox API, with masked or unmasked fields and rate limits explained.","href":"/api-reference/get-lead"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Query Parameters","slug":"query-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Error Responses","slug":"error-responses","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Get Lead","path":"/leads/get","servers":[{"url":"https://crm.uservox.ai/api/v1"}],"method":"get","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{"leadId":{"schema":[{"type":"string","description":"MongoDB ObjectId of the lead (required if not using referenceId)"}]},"referenceId":{"schema":[{"type":"string","description":"External reference ID (requires projectId and processId)"}]},"projectId":{"schema":[{"type":"string","description":"Required when using referenceId"}]},"processId":{"schema":[{"type":"string","description":"Required when using referenceId"}]},"masked":{"schema":[{"type":"boolean","description":"If `true` , masks phone number (all but last 4 digits)"}]}},"header":{},"cookie":{},"path":{}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"success":[{"type":"boolean","description":"Indicates if the request was successful"}],"data":[{"type":"object","properties":{"_id":[{"type":"string","description":"MongoDB ObjectId of the lead"}],"name":[{"type":"string","description":"Lead’s name"}],"phone":[{"type":"string","description":"Phone number"}],"email":[{"type":"string","description":"Email address"}],"projectId":[{"type":"string","description":"Project ID"}],"processId":[{"type":"string","description":"Process ID"}],"referenceId":[{"type":"string","description":"External reference ID"}],"currentState":[{"type":"string","description":"Current state of the lead"}],"lastDisposition":[{"type":"string","description":"Last disposition"}],"metadata":[{"type":"object","properties":{},"description":"Lead metadata"}],"createdAt":[{"type":"string","description":"ISO 8601 timestamp of creation"}],"updatedAt":[{"type":"string","description":"ISO 8601 timestamp of last update"}],"activities":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Array of activity objects"}]},"description":"The lead object with activities"}]}}],"examples":{"example":{"value":{"success":true,"data":{"_id":"\u003cstring>","name":"\u003cstring>","phone":"\u003cstring>","email":"\u003cstring>","projectId":"\u003cstring>","processId":"\u003cstring>","referenceId":"\u003cstring>","currentState":"\u003cstring>","lastDisposition":"\u003cstring>","metadata":{},"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","activities":[{}]}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"uservox","siteName":"Uservox Docs","title":"Get Lead - Uservox Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T19:12:36.299Z","originalFileLocation":"api-reference/get-lead.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 single lead with all of its call activities through the Uservox API, with masked or unmasked fields and rate limits explained.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Uservox Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/uservox/6JfG41JkCT6k9_XZ/_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/uservox/6JfG41JkCT6k9_XZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/uservox/6JfG41JkCT6k9_XZ/_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/uservox/6JfG41JkCT6k9_XZ/_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/uservox/6JfG41JkCT6k9_XZ/_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/uservox/6JfG41JkCT6k9_XZ/_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/uservox/6JfG41JkCT6k9_XZ/_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/uservox/6JfG41JkCT6k9_XZ/_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/uservox/6JfG41JkCT6k9_XZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Lead - Uservox Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single lead with all of its call activities through the Uservox API, with masked or unmasked fields and rate limits explained.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Uservox Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.uservox.ai/api-reference/get-lead\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://uservox.mintlify.site/_mintlify/api/og/v2?division=Leads\u0026amp;title=Get+Lead\u0026amp;description=Retrieve+a+single+lead+with+all+of+its+call+activities+through+the+Uservox+API%2C+with+masked+or+unmasked+fields+and+rate+limits+explained.\u0026amp;theme=c07a5ba392f34eb82f82ef23\u0026amp;signature=39c135a490e5e0dea74d63ec7ce5d78c50eeac91fd7be711175725a3d3786a97\">\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 Lead - Uservox Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single lead with all of its call activities through the Uservox API, with masked or unmasked fields and rate limits explained.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uservox.mintlify.site/_mintlify/api/og/v2?division=Leads\u0026amp;title=Get+Lead\u0026amp;description=Retrieve+a+single+lead+with+all+of+its+call+activities+through+the+Uservox+API%2C+with+masked+or+unmasked+fields+and+rate+limits+explained.\u0026amp;theme=c07a5ba392f34eb82f82ef23\u0026amp;signature=39c135a490e5e0dea74d63ec7ce5d78c50eeac91fd7be711175725a3d3786a97\">\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/uservox/6JfG41JkCT6k9_XZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Uservox Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.uservox.ai/api-reference/get-lead\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/get-lead.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.uservox.ai/#organization\",\"name\":\"Uservox Docs\",\"url\":\"https://docs.uservox.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://uservox.ai/home/images/logo/logo_dark_lg.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.uservox.ai#website\",\"name\":\"Uservox Docs\",\"url\":\"https://docs.uservox.ai\",\"publisher\":{\"@id\":\"https://docs.uservox.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.uservox.ai/api-reference/get-lead#webpage\",\"url\":\"https://docs.uservox.ai/api-reference/get-lead\",\"name\":\"Get Lead\",\"description\":\"Retrieve a single lead with all of its call activities through the Uservox API, with masked or unmasked fields and rate limits explained.\",\"dateModified\":\"2026-10-23T19:12:36.299Z\",\"isPartOf\":{\"@id\":\"https://docs.uservox.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.uservox.ai/api-reference/get-lead#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.uservox.ai/api-reference/get-lead#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Leads\",\"item\":\"https://docs.uservox.ai/api-reference/initiate-lead\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Lead\",\"item\":\"https://docs.uservox.ai/api-reference/get-lead\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.uservox.ai/api-reference/get-lead#apireference\",\"headline\":\"Get Lead\",\"name\":\"Get Lead\",\"description\":\"Retrieve a single lead with all of its call activities through the Uservox API, with masked or unmasked fields and rate limits explained.\",\"url\":\"https://docs.uservox.ai/api-reference/get-lead\",\"mainEntityOfPage\":{\"@id\":\"https://docs.uservox.ai/api-reference/get-lead#webpage\"},\"dateModified\":\"2026-10-23T19:12:36.299Z\",\"publisher\":{\"@id\":\"https://docs.uservox.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.uservox.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Uservox Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Uservox Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/get-lead.md","siteName":"Uservox Docs","nav":{"global":{"anchors":[{"anchor":"Uservox","icon":"globe","href":"https://uservox.ai"},{"anchor":"Dashboard","icon":"rectangle-terminal","href":"https://app.uservox.ai"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"Leads","pages":[{"title":"Initiate Lead","api":"POST /leads/initiate","href":"/api-reference/initiate-lead"},{"title":"Bulk Initiate Leads","api":"POST /leads/bulk/initiate","href":"/api-reference/bulk-initiate-leads"},{"title":"Update Lead","api":"POST /leads/update","description":"Update a lead's metadata through the Uservox API and optionally move it to a new state. The update is queued and its result sent by webhook.","href":"/api-reference/update-lead"},{"title":"Get Lead","api":"GET /leads/get","href":"/api-reference/get-lead"},{"title":"Query Leads","api":"GET /leads/query","description":"Query multiple leads through the Uservox API with optional filters such as process, state and date, with pagination of the results.","href":"/api-reference/query-leads"}]},{"group":"Activities","pages":[{"title":"Activity Payloads","href":"/api-reference/activity-payloads"},{"title":"Callback Payloads","href":"/api-reference/lead-update-callback-payloads"},{"title":"Get Activity by ID","api":"GET /leads/activity/get","href":"/api-reference/get-activity"}]},{"group":"Conversations","pages":[{"title":"Get Conversation Stats","api":"POST /conversations/search/dsl/stats","href":"/api-reference/get-conversation-stats"}]},{"group":"Analytics","pages":[{"title":"Get Activity Stats","api":"POST https://api.uservox.ai/api/v1/analytics/customer/stats","href":"/api-reference/get-activity-stats"}]},{"group":"Processes","pages":[{"title":"List Processes","api":"GET /processes/list/{projectId}","href":"/api-reference/list-processes"}]}]}]},"basePath":"","title":"Get Lead - Uservox Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js"]}