The Rejected form's built-in reason. Shown to the partner in the portal and the rejection email when the lead is rejected, unless the company hides it. Cleared when the lead leaves Rejected.
The Accepted form's built-in reason. Shown to the partner in the portal and the Lead accepted notification when the lead is accepted (status converted), unless the company hides it. Cleared when the lead leaves Accepted.
Answers to the form of the lead's current status: lead_acceptance fields while it is converted (Accepted), lead_rejection fields while it is rejected, empty otherwise. Includes internal (non-shared) fields. Write them with custom_fields on the lead update or the lead custom-field endpoints.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Journeybee API","colors":{"primary":"#007aff"},"logo":{"light":"https://mintcdn.com/journeybee/OYst47RAi-INCv0T/logo-light.svg?fit=max\u0026auto=format\u0026n=OYst47RAi-INCv0T\u0026q=85\u0026s=8afc66d3e6015e470883014b04a24784","dark":"https://mintcdn.com/journeybee/OYst47RAi-INCv0T/logo-dark.svg?fit=max\u0026auto=format\u0026n=OYst47RAi-INCv0T\u0026q=85\u0026s=0911c07015635ad1edf6f86660d20de5"},"api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://support.journeybee.io","label":"Support"},{"href":"https://app.journeybee.io","label":"Dashboard"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/journeybee-partners"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"journeybee","hasAudioNarration":false,"actualSubdomain":"journeybee","customDomains":["docs.journeybee.io"],"gitSource":{"type":"github","owner":"journeybeeio","repo":"journeybee","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae5e5756d5c730af24f0bc5","collectionId":"a4820c1f-3afc-4652-b9e7-513da999e9ca","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae5e5756d5c730af24f0bc5"},"entitlements":{},"buildId":"6ae5ee6b3a58a57f20b855e1","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":694},{"language":"default","tag":"Analytics","count":27},{"language":"default","tag":"Webhook Events","count":16},{"language":"default","tag":"Guides","count":13},{"language":"default","tag":"Partner API","count":13},{"language":"default","tag":"Campaign Audience","count":12},{"language":"default","tag":"Room Secure Files","count":12},{"language":"default","tag":"Partner API Reference","count":11},{"language":"default","tag":"Partner","count":11},{"language":"default","tag":"Campaigns","count":10}]},"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},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/leads/get-a-lead","slug":"/api-reference/leads/get-a-lead","pageMetadata":{"title":"Get a lead","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}","href":"/api-reference/leads/get-a-lead","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a lead","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}","href":"/api-reference/leads/get-a-lead","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getLead","summary":"Get a lead","tags":["Leads"],"parameters":["78098bbf-9ea9-4fcb-a6de-d2403907fcb6"],"x-capability":{"contract_version":2,"key":"openapi:admin.getLead","version":1,"identity":{"source":"openapi","name":"call_endpoint","operationId":"getLead","method":"GET","surface":"admin"},"operation":{"kind":"read","risk":"read","approval_policy":"none"},"access":{"read":true,"write":false},"access_mode":"all","scope_key":"leads","actors":["api_key","oauth","user","service"],"requirements":{"modules":[],"program_modules":[],"workflow_management":false},"scope":{"object_definitions":[],"programs":[],"portal_membership":"not_applicable"},"entity_kinds":[],"idempotency":{"mode":"none","dry_run":false,"reversible":true},"presentation":{"title":"Get a lead","domain":"Leads","surface":"admin"}},"responses":{"200":"1005a4ab-e0e7-4b9c-8523-f251fc52fa12"},"method":"get","type":"path","servers":["3a893ca8-78a2-4e49-9a49-70bfea69d5a6"],"security":["049d306c-2c25-42ce-9a16-db82cd69e6fc"],"path":"/leads/{uuid}","baseUrlOptions":["https://api.journeybee.io/v1"],"title":"Get a lead","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"78098bbf-9ea9-4fcb-a6de-d2403907fcb6":{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"path","name":"uuid","required":true}},"responses":{"1005a4ab-e0e7-4b9c-8523-f251fc52fa12":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","isRequired":true,"uniqueKey":"uuid","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"first_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"email","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"phone_number.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"phone_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"phone_number","typeLabel":"string | null"},"company_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"company_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"company_name","typeLabel":"string | null"},"source":{"type":"string","isRequired":true,"uniqueKey":"source","typeLabel":"string"},"status":{"type":"string","enum":["new","converted","rejected"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"rejected_reason":{"oneOf":[{"type":"string","description":"The Rejected form's built-in reason. Shown to the partner in the portal and the rejection email when the lead is rejected, unless the company hides it. Cleared when the lead leaves Rejected.","isRequired":true,"uniqueKey":"rejected_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Rejected form's built-in reason. Shown to the partner in the portal and the rejection email when the lead is rejected, unless the company hides it. Cleared when the lead leaves Rejected.","isRequired":true,"uniqueKey":"rejected_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rejected_reason","typeLabel":"string | null"},"accepted_reason":{"oneOf":[{"type":"string","description":"The Accepted form's built-in reason. Shown to the partner in the portal and the Lead accepted notification when the lead is accepted (status converted), unless the company hides it. Cleared when the lead leaves Accepted.","isRequired":true,"uniqueKey":"accepted_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Accepted form's built-in reason. Shown to the partner in the portal and the Lead accepted notification when the lead is accepted (status converted), unless the company hides it. Cleared when the lead leaves Accepted.","isRequired":true,"uniqueKey":"accepted_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accepted_reason","typeLabel":"string | null"},"direction":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"direction.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"direction.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"direction","typeLabel":"string | null"},"partner":{"oneOf":[{"type":"object","required":["uuid","name","partner_type"],"properties":{"uuid":{"type":"string","isRequired":true,"uniqueKey":"partner.oneOf.0.uuid","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"partner.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"partner.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"partner.oneOf.0.name","typeLabel":"string | null"},"partner_type":{"type":"string","enum":["referral","reseller","distributor"],"isRequired":true,"uniqueKey":"partner.oneOf.0.partner_type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"partner.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"partner.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"partner","typeLabel":"object | null"},"created_by":{"oneOf":[{"type":"object","required":["uuid","first_name","last_name","email"],"properties":{"uuid":{"type":"string","isRequired":true,"uniqueKey":"created_by.oneOf.0.uuid","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"created_by.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"created_by.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_by.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"created_by.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"created_by.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_by.oneOf.0.last_name","typeLabel":"string | null"},"email":{"type":"string","isRequired":true,"uniqueKey":"created_by.oneOf.0.email","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"created_by.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"created_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_by","typeLabel":"object | null"},"tags":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","isRequired":true,"uniqueKey":"tags.items.[INDEX].uuid","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"tags.items.[INDEX].label","typeLabel":"string"}},"required":["uuid","label"],"additionalProperties":false,"uniqueKey":"tags.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"tags","typeLabel":"object[]"},"assigned_users":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","isRequired":true,"uniqueKey":"assigned_users.items.[INDEX].uuid","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"assigned_users.items.[INDEX].email","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"assigned_users.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"assigned_users.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"assigned_users.items.[INDEX].first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"assigned_users.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"assigned_users.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"assigned_users.items.[INDEX].last_name","typeLabel":"string | null"}},"required":["uuid","email","first_name","last_name"],"additionalProperties":false,"uniqueKey":"assigned_users.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"assigned_users","typeLabel":"object[]"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].uuid","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","textarea","email","website","phone","number","date","boolean","checkbox","select","multi_select"],"isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"object","properties":{"text":{"oneOf":[{"type":"string","description":"Value for text-like fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value for text-like fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.text","typeLabel":"string | null"},"textarea":{"oneOf":[{"type":"string","description":"Legacy value key for textarea fields; write using text","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.textarea.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legacy value key for textarea fields; write using text","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.textarea.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.textarea","typeLabel":"string | null"},"number":{"oneOf":[{"type":"number","description":"Value for number fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.number.oneOf.0","typeLabel":"number"},{"type":"string","description":"Value for number fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.number.oneOf.1","typeLabel":"string"},{"type":"null","description":"Value for number fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.number.oneOf.2","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.number","typeLabel":"number | string | null"},"date":{"oneOf":[{"type":"string","description":"Value for date fields (ISO 8601 date string)","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value for date fields (ISO 8601 date string)","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.date","typeLabel":"string | null"},"boolean":{"oneOf":[{"type":"boolean","description":"Value for checkbox fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.boolean.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"Value for checkbox fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.boolean.oneOf.1","typeLabel":"string"},{"type":"null","description":"Value for checkbox fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.boolean.oneOf.2","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.boolean","typeLabel":"boolean | string | null"},"select":{"oneOf":[{"type":"number","description":"Option ID for single-select fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.select.oneOf.0","typeLabel":"number"},{"type":"null","description":"Option ID for single-select fields","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.select.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.select","typeLabel":"number | null"},"multi_select":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.multi_select.oneOf.0.items.[INDEX]","typeLabel":"number"},"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.multi_select.oneOf.0","typeLabel":"number[]"},{"type":"string","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.multi_select.oneOf.1","typeLabel":"string"},{"type":"null","uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.multi_select.oneOf.2","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0.multi_select","typeLabel":"number[] | string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].value","typeLabel":"object | null"},"options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].options.oneOf.0.items.[INDEX].id","typeLabel":"number"},"label":{"type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].options.oneOf.0.items.[INDEX].label","typeLabel":"string"}},"required":["id","label"],"additionalProperties":false,"uniqueKey":"custom_fields.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields.items.[INDEX].options.oneOf.0","typeLabel":"object[]"},{"type":"null","uniqueKey":"custom_fields.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].options","typeLabel":"object[] | null"}},"required":["uuid","label","type","value"],"additionalProperties":false,"uniqueKey":"custom_fields.items.[INDEX]","typeLabel":"object"},"description":"Values of the lead's custom fields (category lead).","isRequired":true,"uniqueKey":"custom_fields","typeLabel":"object[]"},"status_form_fields":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","isRequired":true,"uniqueKey":"status_form_fields.items.[INDEX].uuid","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"status_form_fields.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","textarea","email","website","phone","number","date","boolean","checkbox","select","multi_select"],"isRequired":true,"uniqueKey":"status_form_fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"object","properties":{"text":{"oneOf":[{"type":"string","description":"Value for text-like fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value for text-like fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.text","typeLabel":"string | null"},"textarea":{"oneOf":[{"type":"string","description":"Legacy value key for textarea fields; write using text","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.textarea.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legacy value key for textarea fields; write using text","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.textarea.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.textarea","typeLabel":"string | null"},"number":{"oneOf":[{"type":"number","description":"Value for number fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.number.oneOf.0","typeLabel":"number"},{"type":"string","description":"Value for number fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.number.oneOf.1","typeLabel":"string"},{"type":"null","description":"Value for number fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.number.oneOf.2","typeLabel":"null"}],"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.number","typeLabel":"number | string | null"},"date":{"oneOf":[{"type":"string","description":"Value for date fields (ISO 8601 date string)","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value for date fields (ISO 8601 date string)","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.date","typeLabel":"string | null"},"boolean":{"oneOf":[{"type":"boolean","description":"Value for checkbox fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.boolean.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"Value for checkbox fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.boolean.oneOf.1","typeLabel":"string"},{"type":"null","description":"Value for checkbox fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.boolean.oneOf.2","typeLabel":"null"}],"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.boolean","typeLabel":"boolean | string | null"},"select":{"oneOf":[{"type":"number","description":"Option ID for single-select fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.select.oneOf.0","typeLabel":"number"},{"type":"null","description":"Option ID for single-select fields","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.select.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.select","typeLabel":"number | null"},"multi_select":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.multi_select.oneOf.0.items.[INDEX]","typeLabel":"number"},"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.multi_select.oneOf.0","typeLabel":"number[]"},{"type":"string","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.multi_select.oneOf.1","typeLabel":"string"},{"type":"null","uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.multi_select.oneOf.2","typeLabel":"null"}],"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0.multi_select","typeLabel":"number[] | string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"status_form_fields.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_form_fields.items.[INDEX].value","typeLabel":"object | null"},"options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"status_form_fields.items.[INDEX].options.oneOf.0.items.[INDEX].id","typeLabel":"number"},"label":{"type":"string","isRequired":true,"uniqueKey":"status_form_fields.items.[INDEX].options.oneOf.0.items.[INDEX].label","typeLabel":"string"}},"required":["id","label"],"additionalProperties":false,"uniqueKey":"status_form_fields.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"status_form_fields.items.[INDEX].options.oneOf.0","typeLabel":"object[]"},{"type":"null","uniqueKey":"status_form_fields.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_form_fields.items.[INDEX].options","typeLabel":"object[] | null"}},"required":["uuid","label","type","value"],"additionalProperties":false,"uniqueKey":"status_form_fields.items.[INDEX]","typeLabel":"object"},"description":"Answers to the form of the lead's current status: lead_acceptance fields while it is converted (Accepted), lead_rejection fields while it is rejected, empty otherwise. Includes internal (non-shared) fields. Write them with custom_fields on the lead update or the lead custom-field endpoints.","isRequired":true,"uniqueKey":"status_form_fields","typeLabel":"object[]"},"created_at":{"type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"updated_at":{"type":"string","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string"}},"required":["uuid","first_name","last_name","email","phone_number","company_name","source","status","rejected_reason","accepted_reason","direction","partner","created_by","tags","assigned_users","custom_fields","status_form_fields","created_at","updated_at"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"uuid":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","email":"\u003cstring>","phone_number":"\u003cstring>","company_name":"\u003cstring>","source":"\u003cstring>","status":"new","rejected_reason":"\u003cstring>","accepted_reason":"\u003cstring>","direction":"\u003cstring>","partner":{"uuid":"\u003cstring>","name":"\u003cstring>","partner_type":"referral"},"created_by":{"uuid":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","email":"\u003cstring>"},"tags":[{"uuid":"\u003cstring>","label":"\u003cstring>"}],"assigned_users":[{"uuid":"\u003cstring>","email":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>"}],"custom_fields":[{"uuid":"\u003cstring>","label":"\u003cstring>","type":"text","value":{"text":"\u003cstring>","textarea":"\u003cstring>","number":123,"date":"\u003cstring>","boolean":true,"select":123,"multi_select":[123]},"options":[{"id":123,"label":"\u003cstring>"}]}],"status_form_fields":[{"uuid":"\u003cstring>","label":"\u003cstring>","type":"text","value":{"text":"\u003cstring>","textarea":"\u003cstring>","number":123,"date":"\u003cstring>","boolean":true,"select":123,"multi_select":[123]},"options":[{"id":123,"label":"\u003cstring>"}]}],"created_at":"\u003cstring>","updated_at":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"049d306c-2c25-42ce-9a16-db82cd69e6fc":{"apiKey":{"type":"http","scheme":"bearer","description":"API key authentication. Use \"Bearer \u003capi_key>\" or \"Api-Key \u003capi_key>\".","scopes":[],"schemeName":"apiKey"}}},"servers":{"3a893ca8-78a2-4e49-9a49-70bfea69d5a6":{"url":"https://api.journeybee.io/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key authentication. Use \"Bearer \u003capi_key>\" or \"Api-Key \u003capi_key>\".","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication. Use \"Bearer \u003capi_key>\" or \"Api-Key \u003capi_key>\".","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"journeybee","siteName":"Journeybee API","title":"Get a lead - Journeybee API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-31T13:34:53.779Z","originalFileLocation":"api-reference/leads/get-a-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=\"application-name\" content=\"Journeybee API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a lead - Journeybee API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Journeybee API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.journeybee.io/api-reference/leads/get-a-lead\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://journeybee.mintlify.app/_mintlify/api/og/v2?division=Leads\u0026amp;title=Get+a+lead\u0026amp;theme=89f88b22c7b4def99f4b3cc2\u0026amp;signature=8464d05de0d4f9e54b816dd7a875db1a8e20ccdd27be42ae62c44074fe38ff33\">\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 a lead - Journeybee API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://journeybee.mintlify.app/_mintlify/api/og/v2?division=Leads\u0026amp;title=Get+a+lead\u0026amp;theme=89f88b22c7b4def99f4b3cc2\u0026amp;signature=8464d05de0d4f9e54b816dd7a875db1a8e20ccdd27be42ae62c44074fe38ff33\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Journeybee API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007aff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.journeybee.io/api-reference/leads/get-a-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/leads/get-a-lead.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.journeybee.io/#organization\",\"name\":\"Journeybee API\",\"url\":\"https://docs.journeybee.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/journeybee/OYst47RAi-INCv0T/logo-light.svg?fit=max\u0026auto=format\u0026n=OYst47RAi-INCv0T\u0026q=85\u0026s=8afc66d3e6015e470883014b04a24784\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.journeybee.io#website\",\"name\":\"Journeybee API\",\"url\":\"https://docs.journeybee.io\",\"publisher\":{\"@id\":\"https://docs.journeybee.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.journeybee.io/api-reference/leads/get-a-lead#webpage\",\"url\":\"https://docs.journeybee.io/api-reference/leads/get-a-lead\",\"name\":\"Get a lead\",\"dateModified\":\"2026-10-31T13:34:53.779Z\",\"isPartOf\":{\"@id\":\"https://docs.journeybee.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.journeybee.io/api-reference/leads/get-a-lead#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.journeybee.io/api-reference/leads/get-a-lead#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.journeybee.io/api-reference/account/get-current-account-info\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Leads\",\"item\":\"https://docs.journeybee.io/api-reference/leads/list-leads\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a lead\",\"item\":\"https://docs.journeybee.io/api-reference/leads/get-a-lead\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.journeybee.io/api-reference/leads/get-a-lead#apireference\",\"headline\":\"Get a lead\",\"name\":\"Get a lead\",\"url\":\"https://docs.journeybee.io/api-reference/leads/get-a-lead\",\"mainEntityOfPage\":{\"@id\":\"https://docs.journeybee.io/api-reference/leads/get-a-lead#webpage\"},\"dateModified\":\"2026-10-31T13:34:53.779Z\",\"publisher\":{\"@id\":\"https://docs.journeybee.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.journeybee.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Journeybee API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Journeybee API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"group":"Account","pages":[{"title":"Get current account info","deprecated":null,"version":null,"openapi":"/openapi.json get /me","href":"/api-reference/account/get-current-account-info"}]},{"group":"Agreement Templates","pages":[{"title":"List registered agreement templates","deprecated":null,"version":null,"openapi":"/openapi.json get /agreement-templates/","href":"/api-reference/agreement-templates/list-registered-agreement-templates"},{"title":"Register or update a provider template","deprecated":null,"version":null,"openapi":"/openapi.json post /agreement-templates/","href":"/api-reference/agreement-templates/register-or-update-a-provider-template"},{"title":"Archive a registered template","deprecated":null,"version":null,"openapi":"/openapi.json delete /agreement-templates/{uuid}","href":"/api-reference/agreement-templates/archive-a-registered-template"}]},{"group":"Agreements","pages":[{"title":"List agreements","deprecated":null,"version":null,"openapi":"/openapi.json get /agreements/","href":"/api-reference/agreements/list-agreements"},{"title":"Create an agreement in `requested`","deprecated":null,"version":null,"openapi":"/openapi.json post /agreements/","href":"/api-reference/agreements/create-an-agreement-in-`requested`"},{"title":"Get an agreement (with its signers)","deprecated":null,"version":null,"openapi":"/openapi.json get /agreements/{uuid}","href":"/api-reference/agreements/get-an-agreement-with-its-signers"},{"title":"Patch an agreement's status and external refs","deprecated":null,"version":null,"openapi":"/openapi.json patch /agreements/{uuid}","href":"/api-reference/agreements/patch-an-agreements-status-and-external-refs"},{"title":"List an agreement's signers","deprecated":null,"version":null,"openapi":"/openapi.json get /agreements/{uuid}/signers","href":"/api-reference/agreements/list-an-agreements-signers"},{"title":"Patch a signer's recipient status","deprecated":null,"version":null,"openapi":"/openapi.json patch /agreements/{uuid}/signers/{signer_uuid}","href":"/api-reference/agreements/patch-a-signers-recipient-status"},{"title":"Request a void on an agreement","deprecated":null,"version":null,"openapi":"/openapi.json post /agreements/{uuid}/void","href":"/api-reference/agreements/request-a-void-on-an-agreement"}]},{"group":"Analytics","pages":[{"title":"Partner revenue leaderboard","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/partners","href":"/api-reference/analytics/partner-revenue-leaderboard"},{"title":"Company revenue summary","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/revenue-summary","href":"/api-reference/analytics/company-revenue-summary"},{"title":"Revenue \u0026 leads over time","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/partners/revenue-time-series","href":"/api-reference/analytics/revenue-\u0026-leads-over-time"},{"title":"Leads sent vs received over time","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/leads-sent-received","href":"/api-reference/analytics/leads-sent-vs-received-over-time"},{"title":"Deals won vs lost over time","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/deals-won-lost","href":"/api-reference/analytics/deals-won-vs-lost-over-time"},{"title":"One partner's leads by month","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/partners/leads-timeline","href":"/api-reference/analytics/one-partners-leads-by-month"},{"title":"One partner's deals by month","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/partners/deals-timeline","href":"/api-reference/analytics/one-partners-deals-by-month"},{"title":"Commission summary","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/commission-summary","href":"/api-reference/analytics/commission-summary"},{"title":"Commission over time","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/commission/time-series","href":"/api-reference/analytics/commission-over-time"},{"title":"Commission leaderboard by partner","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/commission/partners","href":"/api-reference/analytics/commission-leaderboard-by-partner"},{"title":"Engagement summary","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/engagement-summary","href":"/api-reference/analytics/engagement-summary"},{"title":"Engagement over time","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/engagement-time-series","href":"/api-reference/analytics/engagement-over-time"},{"title":"Top resources by views","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/engagement/top-resources","href":"/api-reference/analytics/top-resources-by-views"},{"title":"Top rooms by views","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/engagement/top-rooms","href":"/api-reference/analytics/top-rooms-by-views"},{"title":"Top certifications by views","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/engagement/top-certifications","href":"/api-reference/analytics/top-certifications-by-views"},{"title":"Engagement action breakdown","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/engagement/action-breakdown","href":"/api-reference/analytics/engagement-action-breakdown"},{"title":"Partner engagement leaderboard","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/engagement/partners","href":"/api-reference/analytics/partner-engagement-leaderboard"},{"title":"LMS summary","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms-summary","href":"/api-reference/analytics/lms-summary"},{"title":"LMS over time","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms-time-series","href":"/api-reference/analytics/lms-over-time"},{"title":"Most-completed certifications","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms/top-certifications-by-completion","href":"/api-reference/analytics/most-completed-certifications"},{"title":"Hardest certifications","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms/top-certifications-by-difficulty","href":"/api-reference/analytics/hardest-certifications"},{"title":"Partner training leaderboard","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms/partners","href":"/api-reference/analytics/partner-training-leaderboard"},{"title":"Learner leaderboard","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms/users","href":"/api-reference/analytics/learner-leaderboard"},{"title":"At-risk learners","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms/at-risk-learners","href":"/api-reference/analytics/at-risk-learners"},{"title":"Most-completed certification resources","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms/cert-resource-completions","href":"/api-reference/analytics/most-completed-certification-resources"},{"title":"Hardest certification quizzes","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms/cert-resource-pass-rates","href":"/api-reference/analytics/hardest-certification-quizzes"},{"title":"Certification enrolments (paginated)","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/lms/enrollments","href":"/api-reference/analytics/certification-enrolments-paginated"}]},{"group":"Assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"/openapi.json get /assets/","href":"/api-reference/assets/list-assets"},{"title":"Upload an asset from URL","deprecated":null,"version":null,"openapi":"/openapi.json post /assets/","href":"/api-reference/assets/upload-an-asset-from-url"},{"title":"Get an asset","deprecated":null,"version":null,"openapi":"/openapi.json get /assets/{uuid}","href":"/api-reference/assets/get-an-asset"},{"title":"Delete an asset","deprecated":null,"version":null,"openapi":"/openapi.json delete /assets/{uuid}","href":"/api-reference/assets/delete-an-asset"},{"title":"Update an asset","deprecated":null,"version":null,"openapi":"/openapi.json patch /assets/{uuid}","href":"/api-reference/assets/update-an-asset"},{"title":"Upload a private asset by bytes","deprecated":null,"version":null,"openapi":"/openapi.json post /assets/private-upload","href":"/api-reference/assets/upload-a-private-asset-by-bytes"}]},{"group":"Attributions","pages":[{"title":"List attribution types","deprecated":null,"version":null,"openapi":"/openapi.json get /attributions/","href":"/api-reference/attributions/list-attribution-types"},{"title":"Create an attribution type","deprecated":null,"version":null,"openapi":"/openapi.json post /attributions/","href":"/api-reference/attributions/create-an-attribution-type"},{"title":"Get an attribution type","deprecated":null,"version":null,"openapi":"/openapi.json get /attributions/{uuid}","href":"/api-reference/attributions/get-an-attribution-type"},{"title":"Archive an attribution type","deprecated":null,"version":null,"openapi":"/openapi.json delete /attributions/{uuid}","href":"/api-reference/attributions/archive-an-attribution-type"},{"title":"Update an attribution type","deprecated":null,"version":null,"openapi":"/openapi.json patch /attributions/{uuid}","href":"/api-reference/attributions/update-an-attribution-type"}]},{"group":"Audit Log","pages":[{"title":"List audit log entries","deprecated":null,"version":null,"openapi":"/openapi.json get /audit-log/","href":"/api-reference/audit-log/list-audit-log-entries"}]},{"group":"Automations","pages":[{"title":"List automation workflows","deprecated":null,"version":null,"openapi":"/openapi.json get /automations/","href":"/api-reference/automations/list-automation-workflows"},{"title":"Create an automation workflow (label, description, trigger, partner types, schedule)","deprecated":null,"version":null,"openapi":"/openapi.json post /automations/","href":"/api-reference/automations/create-an-automation-workflow-label-description-trigger-partner-types-schedule"},{"title":"Get an automation workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /automations/{uuid}","href":"/api-reference/automations/get-an-automation-workflow"},{"title":"Archive an automation workflow","deprecated":null,"version":null,"openapi":"/openapi.json delete /automations/{uuid}","href":"/api-reference/automations/archive-an-automation-workflow"},{"title":"Update an automation workflow (label, description, trigger, partner types, schedule, graph)","deprecated":null,"version":null,"openapi":"/openapi.json patch /automations/{uuid}","href":"/api-reference/automations/update-an-automation-workflow-label-description-trigger-partner-types-schedule-graph"},{"title":"Activate or deactivate an automation workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /automations/{uuid}/toggle","href":"/api-reference/automations/activate-or-deactivate-an-automation-workflow"}]},{"group":"Campaign Audience","pages":[{"title":"Add a tier filter to a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{uuid}/tiers","href":"/api-reference/campaign-audience/add-a-tier-filter-to-a-campaign"},{"title":"Remove a tier filter from a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{uuid}/tiers/{subUuid}","href":"/api-reference/campaign-audience/remove-a-tier-filter-from-a-campaign"},{"title":"Add a specific partnership to a campaign audience","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{uuid}/recipient-partnerships","href":"/api-reference/campaign-audience/add-a-specific-partnership-to-a-campaign-audience"},{"title":"Remove a specific partnership from a campaign audience","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{uuid}/recipient-partnerships/{subUuid}","href":"/api-reference/campaign-audience/remove-a-specific-partnership-from-a-campaign-audience"},{"title":"Add a category filter to a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{uuid}/categories","href":"/api-reference/campaign-audience/add-a-category-filter-to-a-campaign"},{"title":"Remove a category filter from a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{uuid}/categories/{subUuid}","href":"/api-reference/campaign-audience/remove-a-category-filter-from-a-campaign"},{"title":"Add a partnership-stage filter to a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{uuid}/stages","href":"/api-reference/campaign-audience/add-a-partnership-stage-filter-to-a-campaign"},{"title":"Add a contact tag filter to a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{uuid}/contact-tags","href":"/api-reference/campaign-audience/add-a-contact-tag-filter-to-a-campaign"},{"title":"Remove a contact tag filter from a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{uuid}/contact-tags/{subUuid}","href":"/api-reference/campaign-audience/remove-a-contact-tag-filter-from-a-campaign"},{"title":"Add an explicit contact to a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{uuid}/contacts","href":"/api-reference/campaign-audience/add-an-explicit-contact-to-a-campaign"},{"title":"Remove an explicit contact from a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{uuid}/contacts/{subUuid}","href":"/api-reference/campaign-audience/remove-an-explicit-contact-from-a-campaign"},{"title":"Remove a partnership-stage filter from a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{uuid}/stages/{subUuid}","href":"/api-reference/campaign-audience/remove-a-partnership-stage-filter-from-a-campaign"}]},{"group":"Campaign Partners","pages":[{"title":"Share a campaign with a partner","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{uuid}/partners","href":"/api-reference/campaign-partners/share-a-campaign-with-a-partner"},{"title":"Remove a partner from a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{uuid}/partners/{subUuid}","href":"/api-reference/campaign-partners/remove-a-partner-from-a-campaign"}]},{"group":"Campaigns","pages":[{"title":"Campaign lead stats","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/lead-stats","href":"/api-reference/campaigns/campaign-lead-stats"},{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/","href":"/api-reference/campaigns/create-a-campaign"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{uuid}","href":"/api-reference/campaigns/get-a-campaign"},{"title":"Archive a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{uuid}","href":"/api-reference/campaigns/archive-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/openapi.json patch /campaigns/{uuid}","href":"/api-reference/campaigns/update-a-campaign"},{"title":"List a campaign's leads","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{uuid}/leads","href":"/api-reference/campaigns/list-a-campaigns-leads"},{"title":"Preview campaign recipients","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{uuid}/recipients","href":"/api-reference/campaigns/preview-campaign-recipients"},{"title":"Get campaign submission statistics","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{uuid}/statistics","href":"/api-reference/campaigns/get-campaign-submission-statistics"},{"title":"Send a test email for a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{uuid}/test-send","href":"/api-reference/campaigns/send-a-test-email-for-a-campaign"}]},{"group":"Card Assignees","pages":[{"title":"Assign a user to a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json post /cards/{uuid}/assignees","href":"/api-reference/card-assignees/assign-a-user-to-a-kanban-card"},{"title":"Unassign a user from a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json delete /cards/{uuid}/assignees/{subUuid}","href":"/api-reference/card-assignees/unassign-a-user-from-a-kanban-card"}]},{"group":"Card Partners","pages":[{"title":"Link a partner to a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json post /cards/{uuid}/partners","href":"/api-reference/card-partners/link-a-partner-to-a-kanban-card"},{"title":"Unlink a partner from a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json delete /cards/{uuid}/partners/{subUuid}","href":"/api-reference/card-partners/unlink-a-partner-from-a-kanban-card"}]},{"group":"Card Tags","pages":[{"title":"Add a tag to a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json post /cards/{uuid}/tags","href":"/api-reference/card-tags/add-a-tag-to-a-kanban-card"},{"title":"Remove a tag from a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json delete /cards/{uuid}/tags/{subUuid}","href":"/api-reference/card-tags/remove-a-tag-from-a-kanban-card"}]},{"group":"Cards","pages":[{"title":"Get a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json get /cards/{uuid}","href":"/api-reference/cards/get-a-kanban-card"},{"title":"Archive a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json delete /cards/{uuid}","href":"/api-reference/cards/archive-a-kanban-card"},{"title":"Update a kanban card","deprecated":null,"version":null,"openapi":"/openapi.json patch /cards/{uuid}","href":"/api-reference/cards/update-a-kanban-card"}]},{"group":"Categories","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/openapi.json get /categories/","href":"/api-reference/categories/list-categories"},{"title":"Create a category","deprecated":null,"version":null,"openapi":"/openapi.json post /categories/","href":"/api-reference/categories/create-a-category"},{"title":"Delete a category","deprecated":null,"version":null,"openapi":"/openapi.json delete /categories/{uuid}","href":"/api-reference/categories/delete-a-category"},{"title":"Update a category","deprecated":null,"version":null,"openapi":"/openapi.json patch /categories/{uuid}","href":"/api-reference/categories/update-a-category"}]},{"group":"Certification Categories","pages":[{"title":"Add a category to a certification","deprecated":null,"version":null,"openapi":"/openapi.json post /certifications/{uuid}/categories","href":"/api-reference/certification-categories/add-a-category-to-a-certification"},{"title":"Remove a category from a certification","deprecated":null,"version":null,"openapi":"/openapi.json delete /certifications/{uuid}/categories/{subUuid}","href":"/api-reference/certification-categories/remove-a-category-from-a-certification"}]},{"group":"Certification Enrollments","pages":[{"title":"List enrollments for a certification","deprecated":null,"version":null,"openapi":"/openapi.json get /certifications/{uuid}/enrollments","href":"/api-reference/certification-enrollments/list-enrollments-for-a-certification"},{"title":"Enroll a user in a certification","deprecated":null,"version":null,"openapi":"/openapi.json post /certifications/{uuid}/enrollments","href":"/api-reference/certification-enrollments/enroll-a-user-in-a-certification"}]},{"group":"Certification Folders","pages":[{"title":"Add a folder to a certification","deprecated":null,"version":null,"openapi":"/openapi.json post /certifications/{uuid}/folders","href":"/api-reference/certification-folders/add-a-folder-to-a-certification"},{"title":"Remove a folder from a certification","deprecated":null,"version":null,"openapi":"/openapi.json delete /certifications/{uuid}/folders/{subUuid}","href":"/api-reference/certification-folders/remove-a-folder-from-a-certification"}]},{"group":"Certification Resources","pages":[{"title":"List curriculum resources for a certification","deprecated":null,"version":null,"openapi":"/openapi.json get /certifications/{uuid}/resources","href":"/api-reference/certification-resources/list-curriculum-resources-for-a-certification"},{"title":"Add a curriculum resource to a certification","deprecated":null,"version":null,"openapi":"/openapi.json post /certifications/{uuid}/resources","href":"/api-reference/certification-resources/add-a-curriculum-resource-to-a-certification"},{"title":"Remove a curriculum resource from a certification","deprecated":null,"version":null,"openapi":"/openapi.json delete /certifications/{uuid}/resources/{subUuid}","href":"/api-reference/certification-resources/remove-a-curriculum-resource-from-a-certification"},{"title":"Update a curriculum resource in a certification","deprecated":null,"version":null,"openapi":"/openapi.json patch /certifications/{uuid}/resources/{subUuid}","href":"/api-reference/certification-resources/update-a-curriculum-resource-in-a-certification"}]},{"group":"Certifications","pages":[{"title":"List certifications","deprecated":null,"version":null,"openapi":"/openapi.json get /certifications/","href":"/api-reference/certifications/list-certifications"},{"title":"Create a certification","deprecated":null,"version":null,"openapi":"/openapi.json post /certifications/","href":"/api-reference/certifications/create-a-certification"},{"title":"Get a certification","deprecated":null,"version":null,"openapi":"/openapi.json get /certifications/{uuid}","href":"/api-reference/certifications/get-a-certification"},{"title":"Archive a certification","deprecated":null,"version":null,"openapi":"/openapi.json delete /certifications/{uuid}","href":"/api-reference/certifications/archive-a-certification"},{"title":"Update a certification","deprecated":null,"version":null,"openapi":"/openapi.json patch /certifications/{uuid}","href":"/api-reference/certifications/update-a-certification"}]},{"group":"Commissions","pages":[{"title":"List commission rules","deprecated":null,"version":null,"openapi":"/openapi.json get /commissions/","href":"/api-reference/commissions/list-commission-rules"},{"title":"Create a commission rule","deprecated":null,"version":null,"openapi":"/openapi.json post /commissions/","href":"/api-reference/commissions/create-a-commission-rule"},{"title":"Get a commission rule","deprecated":null,"version":null,"openapi":"/openapi.json get /commissions/{uuid}","href":"/api-reference/commissions/get-a-commission-rule"},{"title":"Delete a commission rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /commissions/{uuid}","href":"/api-reference/commissions/delete-a-commission-rule"},{"title":"Update a commission rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /commissions/{uuid}","href":"/api-reference/commissions/update-a-commission-rule"}]},{"group":"Contacts","pages":[{"title":"List partner contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/","href":"/api-reference/contacts/list-partner-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{uuid}","href":"/api-reference/contacts/get-a-contact"}]},{"group":"Currencies","pages":[{"title":"List available currencies","deprecated":null,"version":null,"openapi":"/openapi.json get /currencies/","href":"/api-reference/currencies/list-available-currencies"}]},{"group":"Custom Field Options","pages":[{"title":"Add an option to a select/multi-select custom field","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-fields/{uuid}/options","href":"/api-reference/custom-field-options/add-an-option-to-a-selectmulti-select-custom-field"},{"title":"Delete an option from a custom field","deprecated":null,"version":null,"openapi":"/openapi.json delete /custom-fields/{uuid}/options/{optionId}","href":"/api-reference/custom-field-options/delete-an-option-from-a-custom-field"},{"title":"Update an option on a custom field","deprecated":null,"version":null,"openapi":"/openapi.json patch /custom-fields/{uuid}/options/{optionId}","href":"/api-reference/custom-field-options/update-an-option-on-a-custom-field"}]},{"group":"Custom Field Rules","pages":[{"title":"List custom field rules","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-field-rules/","href":"/api-reference/custom-field-rules/list-custom-field-rules"},{"title":"Create a custom field rule","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-field-rules/","href":"/api-reference/custom-field-rules/create-a-custom-field-rule"},{"title":"Delete a custom field rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /custom-field-rules/{uuid}","href":"/api-reference/custom-field-rules/delete-a-custom-field-rule"},{"title":"Update a custom field rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /custom-field-rules/{uuid}","href":"/api-reference/custom-field-rules/update-a-custom-field-rule"}]},{"group":"Custom Field Values","pages":[{"title":"List custom field values for an entity","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-field-values/","href":"/api-reference/custom-field-values/list-custom-field-values-for-an-entity"},{"title":"Set a custom field value on an entity","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-field-values/","href":"/api-reference/custom-field-values/set-a-custom-field-value-on-an-entity"},{"title":"Delete a custom field value","deprecated":null,"version":null,"openapi":"/openapi.json delete /custom-field-values/{uuid}","href":"/api-reference/custom-field-values/delete-a-custom-field-value"},{"title":"Update a custom field value","deprecated":null,"version":null,"openapi":"/openapi.json patch /custom-field-values/{uuid}","href":"/api-reference/custom-field-values/update-a-custom-field-value"}]},{"group":"Custom Fields","pages":[{"title":"List custom field definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-fields/","href":"/api-reference/custom-fields/list-custom-field-definitions"},{"title":"Create a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-fields/","href":"/api-reference/custom-fields/create-a-custom-field-definition"},{"title":"Delete a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.json delete /custom-fields/{uuid}","href":"/api-reference/custom-fields/delete-a-custom-field-definition"},{"title":"Update a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.json patch /custom-fields/{uuid}","href":"/api-reference/custom-fields/update-a-custom-field-definition"}]},{"group":"Deal Commission","pages":[{"title":"Get the commission calculation for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /deals/{uuid}/commission","href":"/api-reference/deal-commission/get-the-commission-calculation-for-a-deal"},{"title":"Set the commission calculation for a deal","deprecated":null,"version":null,"openapi":"/openapi.json put /deals/{uuid}/commission","href":"/api-reference/deal-commission/set-the-commission-calculation-for-a-deal"},{"title":"Clear the commission calculation from a deal","deprecated":null,"version":null,"openapi":"/openapi.json delete /deals/{uuid}/commission","href":"/api-reference/deal-commission/clear-the-commission-calculation-from-a-deal"}]},{"group":"Deal Custom Field Values","pages":[{"title":"Set a custom field value on a deal","deprecated":null,"version":null,"openapi":"/openapi.json put /deals/{uuid}/custom-fields","href":"/api-reference/deal-custom-field-values/set-a-custom-field-value-on-a-deal"},{"title":"Remove a custom field value from a deal","deprecated":null,"version":null,"openapi":"/openapi.json delete /deals/{uuid}/custom-fields/{subUuid}","href":"/api-reference/deal-custom-field-values/remove-a-custom-field-value-from-a-deal"}]},{"group":"Deal Notes","pages":[{"title":"List notes for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /deals/{uuid}/notes","href":"/api-reference/deal-notes/list-notes-for-a-deal"},{"title":"Create a note on a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /deals/{uuid}/notes","href":"/api-reference/deal-notes/create-a-note-on-a-deal"},{"title":"Delete a note from a deal","deprecated":null,"version":null,"openapi":"/openapi.json delete /deals/{uuid}/notes/{subUuid}","href":"/api-reference/deal-notes/delete-a-note-from-a-deal"}]},{"group":"Deal Partner Roles","pages":[{"title":"List deal partner roles","deprecated":null,"version":null,"openapi":"/openapi.json get /deal-partner-roles/","href":"/api-reference/deal-partner-roles/list-deal-partner-roles"},{"title":"Create a deal partner role","deprecated":null,"version":null,"openapi":"/openapi.json post /deal-partner-roles/","href":"/api-reference/deal-partner-roles/create-a-deal-partner-role"},{"title":"Delete a deal partner role","deprecated":null,"version":null,"openapi":"/openapi.json delete /deal-partner-roles/{uuid}","href":"/api-reference/deal-partner-roles/delete-a-deal-partner-role"},{"title":"Rename a deal partner role","deprecated":null,"version":null,"openapi":"/openapi.json patch /deal-partner-roles/{uuid}","href":"/api-reference/deal-partner-roles/rename-a-deal-partner-role"},{"title":"Reorder deal partner roles","deprecated":null,"version":null,"openapi":"/openapi.json put /deal-partner-roles/order","href":"/api-reference/deal-partner-roles/reorder-deal-partner-roles"}]},{"group":"Deal Partners","pages":[{"title":"Add a supporting partner to a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /deals/{uuid}/partners","href":"/api-reference/deal-partners/add-a-supporting-partner-to-a-deal"},{"title":"Remove a supporting partner from a deal","deprecated":null,"version":null,"openapi":"/openapi.json delete /deals/{uuid}/partners/{subUuid}","href":"/api-reference/deal-partners/remove-a-supporting-partner-from-a-deal"},{"title":"Set the primary partner's role on a deal","deprecated":null,"version":null,"openapi":"/openapi.json put /deals/{uuid}/primary-partner-role","href":"/api-reference/deal-partners/set-the-primary-partners-role-on-a-deal"}]},{"group":"Deal Payments","pages":[{"title":"List payments for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /deals/{uuid}/payments","href":"/api-reference/deal-payments/list-payments-for-a-deal"}]},{"group":"Deal Products","pages":[{"title":"List products on a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /deals/{uuid}/products","href":"/api-reference/deal-products/list-products-on-a-deal"},{"title":"Add a product to a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /deals/{uuid}/products","href":"/api-reference/deal-products/add-a-product-to-a-deal"},{"title":"Remove a product from a deal","deprecated":null,"version":null,"openapi":"/openapi.json delete /deals/{uuid}/products/{subUuid}","href":"/api-reference/deal-products/remove-a-product-from-a-deal"},{"title":"Update a product on a deal","deprecated":null,"version":null,"openapi":"/openapi.json patch /deals/{uuid}/products/{subUuid}","href":"/api-reference/deal-products/update-a-product-on-a-deal"}]},{"group":"Deal Stages","pages":[{"title":"List deal stages","deprecated":null,"version":null,"openapi":"/openapi.json get /deal-stages/","href":"/api-reference/deal-stages/list-deal-stages"},{"title":"Create a deal stage","deprecated":null,"version":null,"openapi":"/openapi.json post /deal-stages/","href":"/api-reference/deal-stages/create-a-deal-stage"},{"title":"Delete a deal stage","deprecated":null,"version":null,"openapi":"/openapi.json delete /deal-stages/{uuid}","href":"/api-reference/deal-stages/delete-a-deal-stage"},{"title":"Update a deal stage","deprecated":null,"version":null,"openapi":"/openapi.json patch /deal-stages/{uuid}","href":"/api-reference/deal-stages/update-a-deal-stage"}]},{"group":"Deal Tags","pages":[{"title":"Add a tag to a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /deals/{uuid}/tags","href":"/api-reference/deal-tags/add-a-tag-to-a-deal"},{"title":"Remove a tag from a deal","deprecated":null,"version":null,"openapi":"/openapi.json delete /deals/{uuid}/tags/{subUuid}","href":"/api-reference/deal-tags/remove-a-tag-from-a-deal"}]},{"group":"Deal Tasks","pages":[{"title":"List tasks for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /deals/{uuid}/tasks","href":"/api-reference/deal-tasks/list-tasks-for-a-deal"},{"title":"Create a task on a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /deals/{uuid}/tasks","href":"/api-reference/deal-tasks/create-a-task-on-a-deal"}]},{"group":"Deals","pages":[{"title":"List deals","deprecated":null,"version":null,"openapi":"/openapi.json get /deals/","href":"/api-reference/deals/list-deals"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /deals/","href":"/api-reference/deals/create-a-deal"},{"title":"Get a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /deals/{uuid}","href":"/api-reference/deals/get-a-deal"},{"title":"Archive a deal","deprecated":null,"version":null,"openapi":"/openapi.json delete /deals/{uuid}","href":"/api-reference/deals/archive-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/openapi.json patch /deals/{uuid}","href":"/api-reference/deals/update-a-deal"},{"title":"Get pipeline summary","deprecated":null,"version":null,"openapi":"/openapi.json get /deals/pipeline-summary","href":"/api-reference/deals/get-pipeline-summary"}]},{"group":"Event Subscriptions","pages":[{"title":"List event subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /event-subscriptions/","href":"/api-reference/event-subscriptions/list-event-subscriptions"},{"title":"Create an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /event-subscriptions/","href":"/api-reference/event-subscriptions/create-an-event-subscription"},{"title":"Get an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /event-subscriptions/{uuid}","href":"/api-reference/event-subscriptions/get-an-event-subscription"},{"title":"Delete an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /event-subscriptions/{uuid}","href":"/api-reference/event-subscriptions/delete-an-event-subscription"},{"title":"Update an event subscription (url, event types, status, description)","deprecated":null,"version":null,"openapi":"/openapi.json patch /event-subscriptions/{uuid}","href":"/api-reference/event-subscriptions/update-an-event-subscription-url-event-types-status-description"},{"title":"List a subscription's event deliveries (the v2 delivery log)","deprecated":null,"version":null,"openapi":"/openapi.json get /event-subscriptions/{uuid}/deliveries","href":"/api-reference/event-subscriptions/list-a-subscriptions-event-deliveries-the-v2-delivery-log"},{"title":"Rotate an event subscription's signing secret","deprecated":null,"version":null,"openapi":"/openapi.json post /event-subscriptions/{uuid}/rotate-secret","href":"/api-reference/event-subscriptions/rotate-an-event-subscriptions-signing-secret"},{"title":"Replay a v2 event delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /event-subscriptions/{uuid}/deliveries/{id}/replay","href":"/api-reference/event-subscriptions/replay-a-v2-event-delivery"}]},{"group":"Event Types","pages":[{"title":"List v2 event types","deprecated":null,"version":null,"openapi":"/openapi.json get /event-types/","href":"/api-reference/event-types/list-v2-event-types"}]},{"group":"Folders","pages":[{"title":"List folders","deprecated":null,"version":null,"openapi":"/openapi.json get /folders/","href":"/api-reference/folders/list-folders"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/openapi.json post /folders/","href":"/api-reference/folders/create-a-folder"},{"title":"Get a folder","deprecated":null,"version":null,"openapi":"/openapi.json get /folders/{uuid}","href":"/api-reference/folders/get-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/openapi.json delete /folders/{uuid}","href":"/api-reference/folders/delete-a-folder"},{"title":"Update a folder","deprecated":null,"version":null,"openapi":"/openapi.json patch /folders/{uuid}","href":"/api-reference/folders/update-a-folder"}]},{"group":"Integrations","pages":[{"title":"Get Salesforce partner creation stage gates","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/salesforce/partner-create-stage-gates/","href":"/api-reference/integrations/get-salesforce-partner-creation-stage-gates"},{"title":"Update Salesforce partner creation stage gates","deprecated":null,"version":null,"openapi":"/openapi.json patch /integrations/salesforce/partner-create-stage-gates/","href":"/api-reference/integrations/update-salesforce-partner-creation-stage-gates"}]},{"group":"Lead Attributions","pages":[{"title":"List attributions for a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}/attributions","href":"/api-reference/lead-attributions/list-attributions-for-a-lead"},{"title":"Add an attribution to a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/{uuid}/attributions","href":"/api-reference/lead-attributions/add-an-attribution-to-a-lead"},{"title":"Remove an attribution from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/attributions/{subUuid}","href":"/api-reference/lead-attributions/remove-an-attribution-from-a-lead"}]},{"group":"Lead Contacts","pages":[{"title":"List contacts on a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}/contacts","href":"/api-reference/lead-contacts/list-contacts-on-a-lead"},{"title":"Add a contact to a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/{uuid}/contacts","href":"/api-reference/lead-contacts/add-a-contact-to-a-lead"},{"title":"Remove a contact from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/contacts/{subUuid}","href":"/api-reference/lead-contacts/remove-a-contact-from-a-lead"}]},{"group":"Lead Custom Field Values","pages":[{"title":"Set a custom field value on a lead","deprecated":null,"version":null,"openapi":"/openapi.json put /leads/{uuid}/custom-fields","href":"/api-reference/lead-custom-field-values/set-a-custom-field-value-on-a-lead"},{"title":"Remove a custom field value from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/custom-fields/{subUuid}","href":"/api-reference/lead-custom-field-values/remove-a-custom-field-value-from-a-lead"},{"title":"Update a custom field value on a lead","deprecated":null,"version":null,"openapi":"/openapi.json patch /leads/{uuid}/custom-fields/{subUuid}","href":"/api-reference/lead-custom-field-values/update-a-custom-field-value-on-a-lead"}]},{"group":"Lead Distributor","pages":[{"title":"Get the assigned distributor for a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}/distributor","href":"/api-reference/lead-distributor/get-the-assigned-distributor-for-a-lead"},{"title":"Assign a distributor to a lead","deprecated":null,"version":null,"openapi":"/openapi.json put /leads/{uuid}/distributor","href":"/api-reference/lead-distributor/assign-a-distributor-to-a-lead"},{"title":"Remove the assigned distributor from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/distributor","href":"/api-reference/lead-distributor/remove-the-assigned-distributor-from-a-lead"}]},{"group":"Lead Notes","pages":[{"title":"List notes for a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}/notes","href":"/api-reference/lead-notes/list-notes-for-a-lead"},{"title":"Create a note on a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/{uuid}/notes","href":"/api-reference/lead-notes/create-a-note-on-a-lead"},{"title":"Delete a note from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/notes/{subUuid}","href":"/api-reference/lead-notes/delete-a-note-from-a-lead"}]},{"group":"Lead Products","pages":[{"title":"List products on a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}/products","href":"/api-reference/lead-products/list-products-on-a-lead"},{"title":"Add a product to a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/{uuid}/products","href":"/api-reference/lead-products/add-a-product-to-a-lead"},{"title":"Remove a product from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/products/{subUuid}","href":"/api-reference/lead-products/remove-a-product-from-a-lead"},{"title":"Update a product on a lead","deprecated":null,"version":null,"openapi":"/openapi.json patch /leads/{uuid}/products/{subUuid}","href":"/api-reference/lead-products/update-a-product-on-a-lead"}]},{"group":"Lead Quotes","pages":[{"title":"Get the quote for a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}/quote","href":"/api-reference/lead-quotes/get-the-quote-for-a-lead"},{"title":"Delete the quote from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/quote","href":"/api-reference/lead-quotes/delete-the-quote-from-a-lead"}]},{"group":"Lead Tags","pages":[{"title":"Add a tag to a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/{uuid}/tags","href":"/api-reference/lead-tags/add-a-tag-to-a-lead"},{"title":"Remove a tag from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/tags/{subUuid}","href":"/api-reference/lead-tags/remove-a-tag-from-a-lead"}]},{"group":"Lead Tasks","pages":[{"title":"List tasks for a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}/tasks","href":"/api-reference/lead-tasks/list-tasks-for-a-lead"},{"title":"Create a task on a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/{uuid}/tasks","href":"/api-reference/lead-tasks/create-a-task-on-a-lead"}]},{"group":"Lead Users","pages":[{"title":"Assign a user to a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/{uuid}/assigned-users","href":"/api-reference/lead-users/assign-a-user-to-a-lead"},{"title":"Remove an assigned user from a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}/assigned-users/{subUuid}","href":"/api-reference/lead-users/remove-an-assigned-user-from-a-lead"}]},{"group":"Leads","pages":[{"title":"List leads","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/","href":"/api-reference/leads/list-leads"},{"title":"Create a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/","href":"/api-reference/leads/create-a-lead"},{"title":"Get the lead status forms","description":"Returns the forms a lead status change fills in: the Accepted form (status converted) and the Rejected form (status rejected). For each: whether it is off, optional or required, its custom fields and its built-in reason. Send the answers with the status change in one updateLead call: field values by uuid in `custom_fields`, the reason in `accepted_reason` / `rejected_reason`.","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/status-forms","href":"/api-reference/leads/get-the-lead-status-forms"},{"title":"Get a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/{uuid}","href":"/api-reference/leads/get-a-lead"},{"title":"Archive a lead","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/{uuid}","href":"/api-reference/leads/archive-a-lead"},{"title":"Update a lead","deprecated":null,"version":null,"openapi":"/openapi.json patch /leads/{uuid}","href":"/api-reference/leads/update-a-lead"}]},{"group":"Marketing Templates","pages":[{"title":"List marketing email templates","deprecated":null,"version":null,"openapi":"/openapi.json get /marketing-templates/","href":"/api-reference/marketing-templates/list-marketing-email-templates"},{"title":"Create a marketing email template","deprecated":null,"version":null,"openapi":"/openapi.json post /marketing-templates/","href":"/api-reference/marketing-templates/create-a-marketing-email-template"},{"title":"Get a marketing email template","deprecated":null,"version":null,"openapi":"/openapi.json get /marketing-templates/{uuid}","href":"/api-reference/marketing-templates/get-a-marketing-email-template"},{"title":"Archive a marketing email template","deprecated":null,"version":null,"openapi":"/openapi.json delete /marketing-templates/{uuid}","href":"/api-reference/marketing-templates/archive-a-marketing-email-template"},{"title":"Update a marketing email template","deprecated":null,"version":null,"openapi":"/openapi.json patch /marketing-templates/{uuid}","href":"/api-reference/marketing-templates/update-a-marketing-email-template"}]},{"group":"Partner Contacts","pages":[{"title":"List contacts for a partner","deprecated":null,"version":null,"openapi":"/openapi.json get /partners/{uuid}/contacts","href":"/api-reference/partner-contacts/list-contacts-for-a-partner"},{"title":"Create a contact for a partner","deprecated":null,"version":null,"openapi":"/openapi.json post /partners/{uuid}/contacts","href":"/api-reference/partner-contacts/create-a-contact-for-a-partner"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /partners/{uuid}/contacts/{subUuid}","href":"/api-reference/partner-contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json patch /partners/{uuid}/contacts/{subUuid}","href":"/api-reference/partner-contacts/update-a-contact"}]},{"group":"Partner Custom Field Values","pages":[{"title":"Set a custom field value on a partner","deprecated":null,"version":null,"openapi":"/openapi.json post /partners/{uuid}/custom-fields","href":"/api-reference/partner-custom-field-values/set-a-custom-field-value-on-a-partner"},{"title":"Remove a custom field value from a partner","deprecated":null,"version":null,"openapi":"/openapi.json delete /partners/{uuid}/custom-fields/{subUuid}","href":"/api-reference/partner-custom-field-values/remove-a-custom-field-value-from-a-partner"},{"title":"Update a custom field value on a partner","deprecated":null,"version":null,"openapi":"/openapi.json patch /partners/{uuid}/custom-fields/{subUuid}","href":"/api-reference/partner-custom-field-values/update-a-custom-field-value-on-a-partner"}]},{"group":"Partner Domains","pages":[{"title":"Add a domain to a partner","deprecated":null,"version":null,"openapi":"/openapi.json post /partners/{uuid}/domains","href":"/api-reference/partner-domains/add-a-domain-to-a-partner"},{"title":"Remove a domain from a partner","deprecated":null,"version":null,"openapi":"/openapi.json delete /partners/{uuid}/domains/{subUuid}","href":"/api-reference/partner-domains/remove-a-domain-from-a-partner"}]},{"group":"Partner Notes","pages":[{"title":"List notes for a partner","deprecated":null,"version":null,"openapi":"/openapi.json get /partners/{uuid}/notes","href":"/api-reference/partner-notes/list-notes-for-a-partner"},{"title":"Create a note on a partner","deprecated":null,"version":null,"openapi":"/openapi.json post /partners/{uuid}/notes","href":"/api-reference/partner-notes/create-a-note-on-a-partner"},{"title":"Delete a note from a partner","deprecated":null,"version":null,"openapi":"/openapi.json delete /partners/{uuid}/notes/{subUuid}","href":"/api-reference/partner-notes/delete-a-note-from-a-partner"}]},{"group":"Partner Resellers","pages":[{"title":"List resellers assigned to a distributor","deprecated":null,"version":null,"openapi":"/openapi.json get /partners/{uuid}/resellers","href":"/api-reference/partner-resellers/list-resellers-assigned-to-a-distributor"},{"title":"Assign a reseller to a distributor","deprecated":null,"version":null,"openapi":"/openapi.json post /partners/{uuid}/resellers","href":"/api-reference/partner-resellers/assign-a-reseller-to-a-distributor"},{"title":"Remove a reseller from a distributor","deprecated":null,"version":null,"openapi":"/openapi.json delete /partners/{uuid}/resellers/{subUuid}","href":"/api-reference/partner-resellers/remove-a-reseller-from-a-distributor"}]},{"group":"Partner Stages","pages":[{"title":"List partner stages","deprecated":null,"version":null,"openapi":"/openapi.json get /partner-stages/","href":"/api-reference/partner-stages/list-partner-stages"},{"title":"Create a partner stage","deprecated":null,"version":null,"openapi":"/openapi.json post /partner-stages/","href":"/api-reference/partner-stages/create-a-partner-stage"},{"title":"Delete a partner stage","deprecated":null,"version":null,"openapi":"/openapi.json delete /partner-stages/{uuid}","href":"/api-reference/partner-stages/delete-a-partner-stage"},{"title":"Update a partner stage","deprecated":null,"version":null,"openapi":"/openapi.json patch /partner-stages/{uuid}","href":"/api-reference/partner-stages/update-a-partner-stage"}]},{"group":"Partner Tags","pages":[{"title":"Add a tag to a partner","deprecated":null,"version":null,"openapi":"/openapi.json post /partners/{uuid}/tags","href":"/api-reference/partner-tags/add-a-tag-to-a-partner"},{"title":"Remove a tag from a partner","deprecated":null,"version":null,"openapi":"/openapi.json delete /partners/{uuid}/tags/{subUuid}","href":"/api-reference/partner-tags/remove-a-tag-from-a-partner"}]},{"group":"Partner Users","pages":[{"title":"Assign a user to a partner","deprecated":null,"version":null,"openapi":"/openapi.json post /partners/{uuid}/assigned-users","href":"/api-reference/partner-users/assign-a-user-to-a-partner"},{"title":"Remove a user from a partner","deprecated":null,"version":null,"openapi":"/openapi.json delete /partners/{uuid}/assigned-users/{subUuid}","href":"/api-reference/partner-users/remove-a-user-from-a-partner"}]},{"group":"Partners","pages":[{"title":"List partners","deprecated":null,"version":null,"openapi":"/openapi.json get /partners/","href":"/api-reference/partners/list-partners"},{"title":"Create a partner","deprecated":null,"version":null,"openapi":"/openapi.json post /partners/","href":"/api-reference/partners/create-a-partner"},{"title":"Get a partner","deprecated":null,"version":null,"openapi":"/openapi.json get /partners/{uuid}","href":"/api-reference/partners/get-a-partner"},{"title":"Archive a partner","deprecated":null,"version":null,"openapi":"/openapi.json delete /partners/{uuid}","href":"/api-reference/partners/archive-a-partner"},{"title":"Update a partner","deprecated":null,"version":null,"openapi":"/openapi.json patch /partners/{uuid}","href":"/api-reference/partners/update-a-partner"}]},{"group":"Pricing Calculator Fields","pages":[{"title":"Add a field to a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json post /pricing-calculators/{uuid}/fields","href":"/api-reference/pricing-calculator-fields/add-a-field-to-a-pricing-calculator"},{"title":"Remove a field from a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json delete /pricing-calculators/{uuid}/fields/{subUuid}","href":"/api-reference/pricing-calculator-fields/remove-a-field-from-a-pricing-calculator"},{"title":"Update a field on a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json patch /pricing-calculators/{uuid}/fields/{subUuid}","href":"/api-reference/pricing-calculator-fields/update-a-field-on-a-pricing-calculator"}]},{"group":"Pricing Calculator Formulas","pages":[{"title":"Add a formula to a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json post /pricing-calculators/{uuid}/formulas","href":"/api-reference/pricing-calculator-formulas/add-a-formula-to-a-pricing-calculator"},{"title":"Remove a formula from a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json delete /pricing-calculators/{uuid}/formulas/{subUuid}","href":"/api-reference/pricing-calculator-formulas/remove-a-formula-from-a-pricing-calculator"},{"title":"Update a formula on a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json patch /pricing-calculators/{uuid}/formulas/{subUuid}","href":"/api-reference/pricing-calculator-formulas/update-a-formula-on-a-pricing-calculator"}]},{"group":"Pricing Calculator Products","pages":[{"title":"Add a product to a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json post /pricing-calculators/{uuid}/products","href":"/api-reference/pricing-calculator-products/add-a-product-to-a-pricing-calculator"},{"title":"Remove a product from a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json delete /pricing-calculators/{uuid}/products/{subUuid}","href":"/api-reference/pricing-calculator-products/remove-a-product-from-a-pricing-calculator"},{"title":"Update a product on a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json patch /pricing-calculators/{uuid}/products/{subUuid}","href":"/api-reference/pricing-calculator-products/update-a-product-on-a-pricing-calculator"}]},{"group":"Pricing Calculators","pages":[{"title":"List pricing calculators","deprecated":null,"version":null,"openapi":"/openapi.json get /pricing-calculators/","href":"/api-reference/pricing-calculators/list-pricing-calculators"},{"title":"Create a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json post /pricing-calculators/","href":"/api-reference/pricing-calculators/create-a-pricing-calculator"},{"title":"Get a pricing calculator with fields, products, and formulas","deprecated":null,"version":null,"openapi":"/openapi.json get /pricing-calculators/{uuid}","href":"/api-reference/pricing-calculators/get-a-pricing-calculator-with-fields-products-and-formulas"},{"title":"Archive a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json delete /pricing-calculators/{uuid}","href":"/api-reference/pricing-calculators/archive-a-pricing-calculator"},{"title":"Update a pricing calculator","deprecated":null,"version":null,"openapi":"/openapi.json patch /pricing-calculators/{uuid}","href":"/api-reference/pricing-calculators/update-a-pricing-calculator"},{"title":"Preview a pricing calculator without saving a quote","deprecated":null,"version":null,"openapi":"/openapi.json post /pricing-calculators/{uuid}/preview","href":"/api-reference/pricing-calculators/preview-a-pricing-calculator-without-saving-a-quote"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi.json get /products/","href":"/api-reference/products/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi.json post /products/","href":"/api-reference/products/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi.json get /products/{uuid}","href":"/api-reference/products/get-a-product"},{"title":"Archive a product","deprecated":null,"version":null,"openapi":"/openapi.json delete /products/{uuid}","href":"/api-reference/products/archive-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi.json patch /products/{uuid}","href":"/api-reference/products/update-a-product"}]},{"group":"Resource Blocks","pages":[{"title":"List blocks for a resource","deprecated":null,"version":null,"openapi":"/openapi.json get /resources/{uuid}/blocks","href":"/api-reference/resource-blocks/list-blocks-for-a-resource"},{"title":"Add a block to a resource","deprecated":null,"version":null,"openapi":"/openapi.json post /resources/{uuid}/blocks","href":"/api-reference/resource-blocks/add-a-block-to-a-resource"},{"title":"Remove a block from a resource","deprecated":null,"version":null,"openapi":"/openapi.json delete /resources/{uuid}/blocks/{subUuid}","href":"/api-reference/resource-blocks/remove-a-block-from-a-resource"},{"title":"Update a resource block","deprecated":null,"version":null,"openapi":"/openapi.json patch /resources/{uuid}/blocks/{subUuid}","href":"/api-reference/resource-blocks/update-a-resource-block"}]},{"group":"Resource Categories","pages":[{"title":"Add a category to a resource","deprecated":null,"version":null,"openapi":"/openapi.json post /resources/{uuid}/categories","href":"/api-reference/resource-categories/add-a-category-to-a-resource"},{"title":"Remove a category from a resource","deprecated":null,"version":null,"openapi":"/openapi.json delete /resources/{uuid}/categories/{subUuid}","href":"/api-reference/resource-categories/remove-a-category-from-a-resource"}]},{"group":"Resource Folders","pages":[{"title":"Add a resource to a folder","deprecated":null,"version":null,"openapi":"/openapi.json post /resources/{uuid}/folders","href":"/api-reference/resource-folders/add-a-resource-to-a-folder"},{"title":"Remove a resource from a folder","deprecated":null,"version":null,"openapi":"/openapi.json delete /resources/{uuid}/folders/{subUuid}","href":"/api-reference/resource-folders/remove-a-resource-from-a-folder"}]},{"group":"Resource Tags","pages":[{"title":"Add a tag to a resource","deprecated":null,"version":null,"openapi":"/openapi.json post /resources/{uuid}/tags","href":"/api-reference/resource-tags/add-a-tag-to-a-resource"},{"title":"Remove a tag from a resource","deprecated":null,"version":null,"openapi":"/openapi.json delete /resources/{uuid}/tags/{subUuid}","href":"/api-reference/resource-tags/remove-a-tag-from-a-resource"}]},{"group":"Resources","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"/openapi.json get /resources/","href":"/api-reference/resources/list-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/openapi.json post /resources/","href":"/api-reference/resources/create-a-resource"},{"title":"Get a resource","deprecated":null,"version":null,"openapi":"/openapi.json get /resources/{uuid}","href":"/api-reference/resources/get-a-resource"},{"title":"Archive a resource","deprecated":null,"version":null,"openapi":"/openapi.json delete /resources/{uuid}","href":"/api-reference/resources/archive-a-resource"},{"title":"Update a resource","deprecated":null,"version":null,"openapi":"/openapi.json patch /resources/{uuid}","href":"/api-reference/resources/update-a-resource"}]},{"group":"Room Blocks","pages":[{"title":"List blocks for a room","deprecated":null,"version":null,"openapi":"/openapi.json get /rooms/{uuid}/blocks","href":"/api-reference/room-blocks/list-blocks-for-a-room"},{"title":"Add a block to a room","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/blocks","href":"/api-reference/room-blocks/add-a-block-to-a-room"},{"title":"Remove a block from a room","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/blocks/{subUuid}","href":"/api-reference/room-blocks/remove-a-block-from-a-room"},{"title":"Update a room block","deprecated":null,"version":null,"openapi":"/openapi.json patch /rooms/{uuid}/blocks/{subUuid}","href":"/api-reference/room-blocks/update-a-room-block"}]},{"group":"Room Categories","pages":[{"title":"Add a category to a room","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/categories","href":"/api-reference/room-categories/add-a-category-to-a-room"},{"title":"Remove a category from a room","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/categories/{subUuid}","href":"/api-reference/room-categories/remove-a-category-from-a-room"}]},{"group":"Room Partnerships","pages":[{"title":"Add a partnership to a room","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/partnerships","href":"/api-reference/room-partnerships/add-a-partnership-to-a-room"},{"title":"Remove a partnership from a room","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/partnerships/{subUuid}","href":"/api-reference/room-partnerships/remove-a-partnership-from-a-room"},{"title":"Update a partnership's access to a room","deprecated":null,"version":null,"openapi":"/openapi.json patch /rooms/{uuid}/partnerships/{subUuid}","href":"/api-reference/room-partnerships/update-a-partnerships-access-to-a-room"}]},{"group":"Room Secure Files","pages":[{"title":"List folders and files in a secure files block","deprecated":null,"version":null,"openapi":"/openapi.json get /rooms/{uuid}/blocks/{subUuid}/secure-files","href":"/api-reference/room-secure-files/list-folders-and-files-in-a-secure-files-block"},{"title":"Create a folder in a secure files block","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/blocks/{subUuid}/secure-folders","href":"/api-reference/room-secure-files/create-a-folder-in-a-secure-files-block"},{"title":"Delete a secure folder and everything in it","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/blocks/{subUuid}/secure-folders/{folderUuid}","href":"/api-reference/room-secure-files/delete-a-secure-folder-and-everything-in-it"},{"title":"Rename or move a secure folder","deprecated":null,"version":null,"openapi":"/openapi.json patch /rooms/{uuid}/blocks/{subUuid}/secure-folders/{folderUuid}","href":"/api-reference/room-secure-files/rename-or-move-a-secure-folder"},{"title":"Delete a secure file","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/blocks/{subUuid}/secure-files/{fileUuid}","href":"/api-reference/room-secure-files/delete-a-secure-file"},{"title":"Rename or move a secure file","deprecated":null,"version":null,"openapi":"/openapi.json patch /rooms/{uuid}/blocks/{subUuid}/secure-files/{fileUuid}","href":"/api-reference/room-secure-files/rename-or-move-a-secure-file"},{"title":"Create a download link for a secure file","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/blocks/{subUuid}/secure-files/{fileUuid}/download-url","href":"/api-reference/room-secure-files/create-a-download-link-for-a-secure-file"},{"title":"Start a multipart upload into a secure files block","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/blocks/{subUuid}/secure-uploads","href":"/api-reference/room-secure-files/start-a-multipart-upload-into-a-secure-files-block"},{"title":"Get presigned URLs for upload parts","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/blocks/{subUuid}/secure-uploads/{uploadUuid}/parts","href":"/api-reference/room-secure-files/get-presigned-urls-for-upload-parts"},{"title":"Complete a multipart upload","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/blocks/{subUuid}/secure-uploads/{uploadUuid}/complete","href":"/api-reference/room-secure-files/complete-a-multipart-upload"},{"title":"Abort a multipart upload","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/blocks/{subUuid}/secure-uploads/{uploadUuid}","href":"/api-reference/room-secure-files/abort-a-multipart-upload"},{"title":"List download history for a secure files block","deprecated":null,"version":null,"openapi":"/openapi.json get /rooms/{uuid}/blocks/{subUuid}/secure-downloads","href":"/api-reference/room-secure-files/list-download-history-for-a-secure-files-block"}]},{"group":"Room Stages","pages":[{"title":"Add a stage to a room","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/stages","href":"/api-reference/room-stages/add-a-stage-to-a-room"},{"title":"Remove a stage from a room","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/stages/{subUuid}","href":"/api-reference/room-stages/remove-a-stage-from-a-room"}]},{"group":"Room Tags","pages":[{"title":"Add a tag to a room","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/tags","href":"/api-reference/room-tags/add-a-tag-to-a-room"},{"title":"Remove a tag from a room","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/tags/{subUuid}","href":"/api-reference/room-tags/remove-a-tag-from-a-room"}]},{"group":"Room Tiers","pages":[{"title":"Add a tier to a room","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/{uuid}/tiers","href":"/api-reference/room-tiers/add-a-tier-to-a-room"},{"title":"Remove a tier from a room","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}/tiers/{subUuid}","href":"/api-reference/room-tiers/remove-a-tier-from-a-room"}]},{"group":"Rooms","pages":[{"title":"List rooms","deprecated":null,"version":null,"openapi":"/openapi.json get /rooms/","href":"/api-reference/rooms/list-rooms"},{"title":"Create a room","deprecated":null,"version":null,"openapi":"/openapi.json post /rooms/","href":"/api-reference/rooms/create-a-room"},{"title":"Get a room","deprecated":null,"version":null,"openapi":"/openapi.json get /rooms/{uuid}","href":"/api-reference/rooms/get-a-room"},{"title":"Archive a room","deprecated":null,"version":null,"openapi":"/openapi.json delete /rooms/{uuid}","href":"/api-reference/rooms/archive-a-room"},{"title":"Update a room","deprecated":null,"version":null,"openapi":"/openapi.json patch /rooms/{uuid}","href":"/api-reference/rooms/update-a-room"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openapi.json get /tags/","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/openapi.json post /tags/","href":"/api-reference/tags/create-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /tags/{uuid}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/openapi.json patch /tags/{uuid}","href":"/api-reference/tags/update-a-tag"}]},{"group":"Task Users","pages":[{"title":"Assign a user to a task","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks/{uuid}/assigned-users","href":"/api-reference/task-users/assign-a-user-to-a-task"},{"title":"Remove an assigned user from a task","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{uuid}/assigned-users/{subUuid}","href":"/api-reference/task-users/remove-an-assigned-user-from-a-task"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/","href":"/api-reference/tasks/list-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks/","href":"/api-reference/tasks/create-a-task"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{uuid}","href":"/api-reference/tasks/get-a-task"},{"title":"Archive a task","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{uuid}","href":"/api-reference/tasks/archive-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/openapi.json patch /tasks/{uuid}","href":"/api-reference/tasks/update-a-task"}]},{"group":"Tiers","pages":[{"title":"List tiers","deprecated":null,"version":null,"openapi":"/openapi.json get /tiers/","href":"/api-reference/tiers/list-tiers"},{"title":"Create a tier","deprecated":null,"version":null,"openapi":"/openapi.json post /tiers/","href":"/api-reference/tiers/create-a-tier"},{"title":"Delete a tier","deprecated":null,"version":null,"openapi":"/openapi.json delete /tiers/{uuid}","href":"/api-reference/tiers/delete-a-tier"},{"title":"Update a tier","deprecated":null,"version":null,"openapi":"/openapi.json patch /tiers/{uuid}","href":"/api-reference/tiers/update-a-tier"}]},{"group":"Users","pages":[{"title":"List company users","deprecated":null,"version":null,"openapi":"/openapi.json get /users/","href":"/api-reference/users/list-company-users"}]},{"group":"Webhook Events","pages":[{"title":"Lead created","version":null,"deprecated":null,"openapi":"/openapi.json webhook leads.create","href":"/api-reference/webhook-events/lead-created"},{"title":"Lead updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook leads.update","href":"/api-reference/webhook-events/lead-updated"},{"title":"Lead deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook leads.delete","href":"/api-reference/webhook-events/lead-deleted"},{"title":"Lead note created","version":null,"deprecated":null,"openapi":"/openapi.json webhook leads.notes_create","href":"/api-reference/webhook-events/lead-note-created"},{"title":"Lead note deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook leads.notes_delete","href":"/api-reference/webhook-events/lead-note-deleted"},{"title":"Deal created","version":null,"deprecated":null,"openapi":"/openapi.json webhook deals.create","href":"/api-reference/webhook-events/deal-created"},{"title":"Deal updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook deals.update","href":"/api-reference/webhook-events/deal-updated"},{"title":"Deal deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook deals.delete","href":"/api-reference/webhook-events/deal-deleted"},{"title":"Deal note created","version":null,"deprecated":null,"openapi":"/openapi.json webhook deals.notes_create","href":"/api-reference/webhook-events/deal-note-created"},{"title":"Deal note updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook deals.notes_update","href":"/api-reference/webhook-events/deal-note-updated"},{"title":"Deal note deleted","version":null,"deprecated":null,"openapi":"/openapi.json webhook deals.notes_delete","href":"/api-reference/webhook-events/deal-note-deleted"},{"title":"Partner created","version":null,"deprecated":null,"openapi":"/openapi.json webhook partners.create","href":"/api-reference/webhook-events/partner-created"},{"title":"Partner updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook partners.update","href":"/api-reference/webhook-events/partner-updated"},{"title":"Partner contact created","version":null,"deprecated":null,"openapi":"/openapi.json webhook partners.contact_create","href":"/api-reference/webhook-events/partner-contact-created"},{"title":"Partner contact updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook partners.contact_update","href":"/api-reference/webhook-events/partner-contact-updated"},{"title":"Message created","version":null,"deprecated":null,"openapi":"/openapi.json webhook messages.create","href":"/api-reference/webhook-events/message-created"}]}]}]},{"tab":"Partner API","pages":[{"title":"Partner API","href":"/guides/partner-api"}]}]},"basePath":"","title":"Get a lead - Journeybee 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"]}