# Journeybee API

## Docs

- [Get current account info](https://docs.journeybee.io/api-reference/account/get-current-account-info.md): Returns the authenticated company, API key permissions, and enabled modules. Use this to check what you can access.
- [At-risk learners](https://docs.journeybee.io/api-reference/analytics/at-risk-learners.md): Learners in progress for over 30 days without completing — candidates for a nudge.
- [Certification enrolments (paginated)](https://docs.journeybee.io/api-reference/analytics/certification-enrolments-paginated.md): Per-learner enrolment rows for a status (in_progress, completed, or failed) over the period. Paginated.
- [Commission leaderboard by partner](https://docs.journeybee.io/api-reference/analytics/commission-leaderboard-by-partner.md): Partners ranked by commission earned (and pending) for the period, in the company base currency, with payment + deal counts. Defaults to the current year.
- [Commission over time](https://docs.journeybee.io/api-reference/analytics/commission-over-time.md): Commission paid and pending per bucket over the period, in the company base currency, with payment counts. Pass partner/category/tier/stage filters. Defaults to the current year.
- [Commission summary](https://docs.journeybee.io/api-reference/analytics/commission-summary.md): Company-wide commission totals for a period — paid (earned), pending, and processing — in the company base currency, plus payment + deal counts. Use this for 'how much commission is owed/earned this period'. This is commission MONEY; for commission RULES use getCommissionReport. Defaults to the curr…
- [Company revenue summary](https://docs.journeybee.io/api-reference/analytics/company-revenue-summary.md): Company-wide totals for a period — revenue, deals won/total, average deal value, partner + lead counts, conversion and win rates — all in the company base currency. Defaults to the current year; pass a `period` or `start_date`+`end_date`. Money is in whole currency units of `currency_code`.
- [Deals won vs lost over time](https://docs.journeybee.io/api-reference/analytics/deals-won-vs-lost-over-time.md): Monthly won/lost deal counts and their base-currency value across all partners (or a `partner_uuids` subset). Deals are bucketed by close month; value is in `currency_code`. Defaults to the current year.
- [Engagement action breakdown](https://docs.journeybee.io/api-reference/analytics/engagement-action-breakdown.md): Counts of each partner action type for the period.
- [Engagement over time](https://docs.journeybee.io/api-reference/analytics/engagement-over-time.md): Sessions, page views and unique users bucketed over the period.
- [Engagement summary](https://docs.journeybee.io/api-reference/analytics/engagement-summary.md): Portal engagement totals for a period: unique users, sessions, page views, actions, and average session duration. Defaults to the current year; pass a `period` or `start_date`+`end_date`.
- [Hardest certification quizzes](https://docs.journeybee.io/api-reference/analytics/hardest-certification-quizzes.md): Certification-bound quiz blocks ranked by lowest pass rate for the period.
- [Hardest certifications](https://docs.journeybee.io/api-reference/analytics/hardest-certifications.md): Certifications ranked by lowest pass rate (hardest) for the period.
- [Leads sent vs received over time](https://docs.journeybee.io/api-reference/analytics/leads-sent-vs-received-over-time.md): Monthly lead counts — received, sent, qualified (converted) and unqualified (rejected) — across all partners (or a `partner_uuids` subset). Defaults to the current year.
- [Learner leaderboard](https://docs.journeybee.io/api-reference/analytics/learner-leaderboard.md): Top learners by certifications earned + average score for the period.
- [LMS over time](https://docs.journeybee.io/api-reference/analytics/lms-over-time.md): Enrolments, completions and passes bucketed over the period.
- [LMS summary](https://docs.journeybee.io/api-reference/analytics/lms-summary.md): Training totals for a period: enrolments, started, completions, passes, pass rate, average score, active learners, certified users, average time to complete. Defaults to the current year.
- [Most-completed certification resources](https://docs.journeybee.io/api-reference/analytics/most-completed-certification-resources.md): Certification-bound resource blocks ranked by completions for the period.
- [Most-completed certifications](https://docs.journeybee.io/api-reference/analytics/most-completed-certifications.md): Certifications ranked by completions for the period.
- [One partner's deals by month](https://docs.journeybee.io/api-reference/analytics/one-partners-deals-by-month.md): A single partner's deals bucketed per month — won/lost/total counts and base-currency value. Requires `partner_uuid`. Value is in `currency_code`. Defaults to the last 6 months when no period is given.
- [One partner's leads by month](https://docs.journeybee.io/api-reference/analytics/one-partners-leads-by-month.md): A single partner's leads bucketed per month by status and direction (total, received, sent, converted, rejected, pending). Requires `partner_uuid`. Defaults to the last 6 months when no period is given.
- [Partner engagement leaderboard](https://docs.journeybee.io/api-reference/analytics/partner-engagement-leaderboard.md): Partners ranked by portal engagement for the period.
- [Partner revenue leaderboard](https://docs.journeybee.io/api-reference/analytics/partner-revenue-leaderboard.md): Partners ranked by revenue for a period, each deal converted to the company base currency. Use this to answer 'best/top partner by revenue/leads/deals' — do NOT list deals and sum them by hand (that mis-handles currencies). Defaults to the current year; pass a `period` or `start_date`+`end_date`. Mo…
- [Partner training leaderboard](https://docs.journeybee.io/api-reference/analytics/partner-training-leaderboard.md): Partners ranked by training completion for the period.
- [Revenue & leads over time](https://docs.journeybee.io/api-reference/analytics/revenue-&-leads-over-time.md): Revenue (deals WON in the bucket) and lead count per month over the period, in the company base currency. Pass `partner_uuids` for one partner's trend, or category/tier/stage filters. Defaults to the current year.
- [Top certifications by views](https://docs.journeybee.io/api-reference/analytics/top-certifications-by-views.md): Most-viewed certifications for the period.
- [Top resources by views](https://docs.journeybee.io/api-reference/analytics/top-resources-by-views.md): Most-viewed resources for the period.
- [Top rooms by views](https://docs.journeybee.io/api-reference/analytics/top-rooms-by-views.md): Most-viewed rooms for the period.
- [Delete an asset](https://docs.journeybee.io/api-reference/assets/delete-an-asset.md)
- [Get an asset](https://docs.journeybee.io/api-reference/assets/get-an-asset.md)
- [List assets](https://docs.journeybee.io/api-reference/assets/list-assets.md)
- [Update an asset](https://docs.journeybee.io/api-reference/assets/update-an-asset.md)
- [Upload an asset from URL](https://docs.journeybee.io/api-reference/assets/upload-an-asset-from-url.md): Fetches a file from the provided public URL and uploads it to Journeybee's CDN. Returns the asset with a UUID that can be used in resource blocks, room blocks, and other content. Maximum file size: 5GB.
- [Archive an attribution type](https://docs.journeybee.io/api-reference/attributions/archive-an-attribution-type.md): Archives the attribution type. It will no longer appear in the default list but existing lead attributions referencing it are preserved.
- [Create an attribution type](https://docs.journeybee.io/api-reference/attributions/create-an-attribution-type.md)
- [Get an attribution type](https://docs.journeybee.io/api-reference/attributions/get-an-attribution-type.md)
- [List attribution types](https://docs.journeybee.io/api-reference/attributions/list-attribution-types.md): Returns attribution type definitions. Use the UUID when adding attributions to leads.
- [Update an attribution type](https://docs.journeybee.io/api-reference/attributions/update-an-attribution-type.md)
- [List audit log entries](https://docs.journeybee.io/api-reference/audit-log/list-audit-log-entries.md): List change-history entries for the company. Filter by entity_type (lead, lead_deal, partnership, lead_deal_payment) and/or entity_uuid for a single entity's trail, or omit both for a company-wide feed. Each entry records what changed (changes[]), the action, the rendered actor, and when.
- [Activate or deactivate an automation workflow](https://docs.journeybee.io/api-reference/automations/activate-or-deactivate-an-automation-workflow.md)
- [Archive an automation workflow](https://docs.journeybee.io/api-reference/automations/archive-an-automation-workflow.md)
- [Create an automation workflow](https://docs.journeybee.io/api-reference/automations/create-an-automation-workflow.md)
- [Get an automation workflow](https://docs.journeybee.io/api-reference/automations/get-an-automation-workflow.md)
- [List automation workflows](https://docs.journeybee.io/api-reference/automations/list-automation-workflows.md)
- [Update an automation workflow (label, description, graph)](https://docs.journeybee.io/api-reference/automations/update-an-automation-workflow-label-description-graph.md)
- [Add a category filter to a campaign](https://docs.journeybee.io/api-reference/campaign-audience/add-a-category-filter-to-a-campaign.md)
- [Add a partnership-stage filter to a campaign](https://docs.journeybee.io/api-reference/campaign-audience/add-a-partnership-stage-filter-to-a-campaign.md)
- [Add a tier filter to a campaign](https://docs.journeybee.io/api-reference/campaign-audience/add-a-tier-filter-to-a-campaign.md)
- [Remove a category filter from a campaign](https://docs.journeybee.io/api-reference/campaign-audience/remove-a-category-filter-from-a-campaign.md)
- [Remove a partnership-stage filter from a campaign](https://docs.journeybee.io/api-reference/campaign-audience/remove-a-partnership-stage-filter-from-a-campaign.md)
- [Remove a tier filter from a campaign](https://docs.journeybee.io/api-reference/campaign-audience/remove-a-tier-filter-from-a-campaign.md)
- [Remove a partner from a campaign](https://docs.journeybee.io/api-reference/campaign-partners/remove-a-partner-from-a-campaign.md)
- [Share a campaign with a partner](https://docs.journeybee.io/api-reference/campaign-partners/share-a-campaign-with-a-partner.md): Add or update a partner's access to the campaign. `shared` exposes the campaign in the partner portal; `shared_leads` shares its leads.
- [Archive a campaign](https://docs.journeybee.io/api-reference/campaigns/archive-a-campaign.md)
- [Campaign lead stats](https://docs.journeybee.io/api-reference/campaigns/campaign-lead-stats.md): Lead counts attributed to each campaign (leads.campaign_id) plus a grand total, in a single call. Ordered by lead count descending; includes campaigns with zero leads. Use this to answer 'how many leads have campaigns produced' instead of fetching each campaign one by one.
- [Create a campaign](https://docs.journeybee.io/api-reference/campaigns/create-a-campaign.md): Create a campaign — the send configuration (audience filters, partner sharing, and a LINK to one email template). A campaign is NOT the email content itself: to create the actual email (a "campaign email" — its header, body, footer), use createMarketingTemplate, then link it here via PATCH email_tem…
- [Get a campaign](https://docs.journeybee.io/api-reference/campaigns/get-a-campaign.md): Get a campaign with its full audience configuration: tier/category/stage filters, shared partners, partner-type flags, and linked email template.
- [List a campaign's leads](https://docs.journeybee.io/api-reference/campaigns/list-a-campaigns-leads.md): List the leads attributed to a campaign (leads.campaign_id). Supports search, status filtering, and pagination. Read-only — sending is done by a human in the app.
- [List campaigns](https://docs.journeybee.io/api-reference/campaigns/list-campaigns.md): List campaigns with optional filtering by status, type, or search. Each campaign includes its linked email template, audience partner-type flags, and tags.
- [Update a campaign](https://docs.journeybee.io/api-reference/campaigns/update-a-campaign.md): Update campaign fields, including status, schedule, partner-type audience flags, and the linked email template (email_template_uuid; null clears it). Audience filters and partner sharing are managed via the sub-resource endpoints.
- [Assign a user to a kanban card](https://docs.journeybee.io/api-reference/card-assignees/assign-a-user-to-a-kanban-card.md)
- [Unassign a user from a kanban card](https://docs.journeybee.io/api-reference/card-assignees/unassign-a-user-from-a-kanban-card.md)
- [Link a partner to a kanban card](https://docs.journeybee.io/api-reference/card-partners/link-a-partner-to-a-kanban-card.md)
- [Unlink a partner from a kanban card](https://docs.journeybee.io/api-reference/card-partners/unlink-a-partner-from-a-kanban-card.md)
- [Add a tag to a kanban card](https://docs.journeybee.io/api-reference/card-tags/add-a-tag-to-a-kanban-card.md)
- [Remove a tag from a kanban card](https://docs.journeybee.io/api-reference/card-tags/remove-a-tag-from-a-kanban-card.md)
- [Archive a kanban card](https://docs.journeybee.io/api-reference/cards/archive-a-kanban-card.md): Archives (soft-deletes) a kanban card.
- [Get a kanban card](https://docs.journeybee.io/api-reference/cards/get-a-kanban-card.md): Returns a kanban card's metadata: title, current stage, the board's available stages (valid stage-move targets), assigned users, tags and linked partners. The rich-text body is edited separately.
- [Update a kanban card](https://docs.journeybee.io/api-reference/cards/update-a-kanban-card.md): Rename a kanban card and/or move it to another stage. Use a stage_uuid from the card's available_stages (see getCard).
- [Create a category](https://docs.journeybee.io/api-reference/categories/create-a-category.md)
- [Delete a category](https://docs.journeybee.io/api-reference/categories/delete-a-category.md)
- [List categories](https://docs.journeybee.io/api-reference/categories/list-categories.md)
- [Update a category](https://docs.journeybee.io/api-reference/categories/update-a-category.md)
- [Add a category to a certification](https://docs.journeybee.io/api-reference/certification-categories/add-a-category-to-a-certification.md)
- [Remove a category from a certification](https://docs.journeybee.io/api-reference/certification-categories/remove-a-category-from-a-certification.md)
- [Enroll a user in a certification](https://docs.journeybee.io/api-reference/certification-enrollments/enroll-a-user-in-a-certification.md)
- [List enrollments for a certification](https://docs.journeybee.io/api-reference/certification-enrollments/list-enrollments-for-a-certification.md)
- [Add a folder to a certification](https://docs.journeybee.io/api-reference/certification-folders/add-a-folder-to-a-certification.md)
- [Remove a folder from a certification](https://docs.journeybee.io/api-reference/certification-folders/remove-a-folder-from-a-certification.md)
- [Add a curriculum resource to a certification](https://docs.journeybee.io/api-reference/certification-resources/add-a-curriculum-resource-to-a-certification.md)
- [List curriculum resources for a certification](https://docs.journeybee.io/api-reference/certification-resources/list-curriculum-resources-for-a-certification.md)
- [Remove a curriculum resource from a certification](https://docs.journeybee.io/api-reference/certification-resources/remove-a-curriculum-resource-from-a-certification.md)
- [Update a curriculum resource in a certification](https://docs.journeybee.io/api-reference/certification-resources/update-a-curriculum-resource-in-a-certification.md)
- [Archive a certification](https://docs.journeybee.io/api-reference/certifications/archive-a-certification.md)
- [Create a certification](https://docs.journeybee.io/api-reference/certifications/create-a-certification.md)
- [Get a certification](https://docs.journeybee.io/api-reference/certifications/get-a-certification.md)
- [List certifications](https://docs.journeybee.io/api-reference/certifications/list-certifications.md)
- [Update a certification](https://docs.journeybee.io/api-reference/certifications/update-a-certification.md)
- [Create a commission rule](https://docs.journeybee.io/api-reference/commissions/create-a-commission-rule.md): Create a commission rule with calculation entries. Optionally scope to specific tiers, categories, or partnerships via their UUIDs.
- [Delete a commission rule](https://docs.journeybee.io/api-reference/commissions/delete-a-commission-rule.md): Permanently deletes a commission rule and all its tier, category, and partnership assignments. Existing deal commissions that were applied from this rule are not affected.
- [Get a commission rule](https://docs.journeybee.io/api-reference/commissions/get-a-commission-rule.md)
- [List commission rules](https://docs.journeybee.io/api-reference/commissions/list-commission-rules.md): Returns commission rule configurations. Filter by `partner_type` (referral/reseller/distributor) or `payment_target` (`partnership` for partner commissions, `individual` for spiffs paid to individual users/contacts).
- [Update a commission rule](https://docs.journeybee.io/api-reference/commissions/update-a-commission-rule.md): Update commission rule properties or calculation entries. When `tier_uuids`, `category_uuids`, or `partnership_uuids` are provided, they **replace** the current assignments entirely (not merge). Omit these fields to leave assignments unchanged. See POST /v1/commissions for the full calculation schem…
- [Get a contact](https://docs.journeybee.io/api-reference/contacts/get-a-contact.md)
- [List partner contacts](https://docs.journeybee.io/api-reference/contacts/list-partner-contacts.md): Returns all partner contacts across partnerships. Filter by partnership_uuid to scope to a specific partner. Each contact includes its partnership reference.
- [List available currencies](https://docs.journeybee.io/api-reference/currencies/list-available-currencies.md): Returns all available currencies. Use the UUID when setting currency on products, deals, or pricing calculators.
- [Add an option to a select/multi-select custom field](https://docs.journeybee.io/api-reference/custom-field-options/add-an-option-to-a-selectmulti-select-custom-field.md)
- [Delete an option from a custom field](https://docs.journeybee.io/api-reference/custom-field-options/delete-an-option-from-a-custom-field.md)
- [Update an option on a custom field](https://docs.journeybee.io/api-reference/custom-field-options/update-an-option-on-a-custom-field.md)
- [Delete a custom field value](https://docs.journeybee.io/api-reference/custom-field-values/delete-a-custom-field-value.md)
- [List custom field values for an entity](https://docs.journeybee.io/api-reference/custom-field-values/list-custom-field-values-for-an-entity.md)
- [Set a custom field value on an entity](https://docs.journeybee.io/api-reference/custom-field-values/set-a-custom-field-value-on-an-entity.md)
- [Update a custom field value](https://docs.journeybee.io/api-reference/custom-field-values/update-a-custom-field-value.md)
- [Create a custom field definition](https://docs.journeybee.io/api-reference/custom-fields/create-a-custom-field-definition.md)
- [Delete a custom field definition](https://docs.journeybee.io/api-reference/custom-fields/delete-a-custom-field-definition.md)
- [List custom field definitions](https://docs.journeybee.io/api-reference/custom-fields/list-custom-field-definitions.md)
- [Update a custom field definition](https://docs.journeybee.io/api-reference/custom-fields/update-a-custom-field-definition.md)
- [Clear the commission calculation from a deal](https://docs.journeybee.io/api-reference/deal-commission/clear-the-commission-calculation-from-a-deal.md): Resets the deal's commission calculation to empty. Existing payments are not affected.
- [Get the commission calculation for a deal](https://docs.journeybee.io/api-reference/deal-commission/get-the-commission-calculation-for-a-deal.md): Returns the commission calculation applied to this deal. The `calculation` contains `entries` — each with a `payment_stage_id` (when payment triggers) and a `calculation` object defining the type (oneOff/recurring/split), option (fixed/percentage/scaling), and value. Returns `null` calculation if no…
- [Set the commission calculation for a deal](https://docs.journeybee.io/api-reference/deal-commission/set-the-commission-calculation-for-a-deal.md): Override the commission calculation on a deal. This replaces the entire `calculation` structure. Use this to manually adjust commissions after they've been auto-applied from a commission rule. The structure matches the commission rule format — see POST /v1/commissions for the full calculation schema…
- [Remove a custom field value from a deal](https://docs.journeybee.io/api-reference/deal-custom-field-values/remove-a-custom-field-value-from-a-deal.md)
- [Set a custom field value on a deal](https://docs.journeybee.io/api-reference/deal-custom-field-values/set-a-custom-field-value-on-a-deal.md): Set or update a custom field value. Custom fields are scoped by partner type — only fields matching the deal's lead partnership type will be relevant.
- [Create a note on a deal](https://docs.journeybee.io/api-reference/deal-notes/create-a-note-on-a-deal.md)
- [Delete a note from a deal](https://docs.journeybee.io/api-reference/deal-notes/delete-a-note-from-a-deal.md)
- [List notes for a deal](https://docs.journeybee.io/api-reference/deal-notes/list-notes-for-a-deal.md)
- [List payments for a deal](https://docs.journeybee.io/api-reference/deal-payments/list-payments-for-a-deal.md): Returns all payment records for a deal including commission and spiff payments, their approval status, and processing state. Payments are read-only via the API.
- [Add a product to a deal](https://docs.journeybee.io/api-reference/deal-products/add-a-product-to-a-deal.md)
- [List products on a deal](https://docs.journeybee.io/api-reference/deal-products/list-products-on-a-deal.md)
- [Remove a product from a deal](https://docs.journeybee.io/api-reference/deal-products/remove-a-product-from-a-deal.md): Only manually added products can be removed.
- [Update a product on a deal](https://docs.journeybee.io/api-reference/deal-products/update-a-product-on-a-deal.md): Update quantity or price override. Only manually added products can be updated (not quote-sourced or lead-sourced).
- [Create a deal stage](https://docs.journeybee.io/api-reference/deal-stages/create-a-deal-stage.md)
- [Delete a deal stage](https://docs.journeybee.io/api-reference/deal-stages/delete-a-deal-stage.md)
- [List deal stages](https://docs.journeybee.io/api-reference/deal-stages/list-deal-stages.md)
- [Update a deal stage](https://docs.journeybee.io/api-reference/deal-stages/update-a-deal-stage.md)
- [Add a tag to a deal](https://docs.journeybee.io/api-reference/deal-tags/add-a-tag-to-a-deal.md)
- [Remove a tag from a deal](https://docs.journeybee.io/api-reference/deal-tags/remove-a-tag-from-a-deal.md)
- [Create a task on a deal](https://docs.journeybee.io/api-reference/deal-tasks/create-a-task-on-a-deal.md): Creates a task attached to this deal. Equivalent to POST /v1/tasks with deal_uuid set.
- [List tasks for a deal](https://docs.journeybee.io/api-reference/deal-tasks/list-tasks-for-a-deal.md)
- [Archive a deal](https://docs.journeybee.io/api-reference/deals/archive-a-deal.md)
- [Create a deal](https://docs.journeybee.io/api-reference/deals/create-a-deal.md): Create a deal on a lead. A lead is required. Multiple deals can exist on the same lead. If no stage is provided, the first deal stage for the lead's partner type is used. If no currency is provided, the company's default currency is used. Deal stages and custom fields are scoped by partner type.
- [Get a deal](https://docs.journeybee.io/api-reference/deals/get-a-deal.md)
- [Get pipeline summary](https://docs.journeybee.io/api-reference/deals/get-pipeline-summary.md): Get a summary of the deal pipeline with deal counts and total values per stage. Values are converted to the company's base currency using locked rates (for won/lost deals) or live exchange rates.
- [List deals](https://docs.journeybee.io/api-reference/deals/list-deals.md): List deals with optional filtering by stage phase, stage UUID, lead, partnership, or search. Each deal includes its linked lead, partner, stage, currency, tags, and custom field values. Note: deal stages and custom fields are scoped by partner type (referral/reseller/distributor).
- [Update a deal](https://docs.journeybee.io/api-reference/deals/update-a-deal.md): Update deal fields. **Note:** Changing `deal_value` does not automatically recalculate commission payments. Commission recalculation will be added in a future release. For now, update the deal commission separately via PUT /v1/deals/{uuid}/commission if needed.
- [Create a folder](https://docs.journeybee.io/api-reference/folders/create-a-folder.md)
- [Delete a folder](https://docs.journeybee.io/api-reference/folders/delete-a-folder.md)
- [Get a folder](https://docs.journeybee.io/api-reference/folders/get-a-folder.md)
- [List folders](https://docs.journeybee.io/api-reference/folders/list-folders.md)
- [Update a folder](https://docs.journeybee.io/api-reference/folders/update-a-folder.md)
- [Add an attribution to a lead](https://docs.journeybee.io/api-reference/lead-attributions/add-an-attribution-to-a-lead.md)
- [List attributions for a lead](https://docs.journeybee.io/api-reference/lead-attributions/list-attributions-for-a-lead.md)
- [Remove an attribution from a lead](https://docs.journeybee.io/api-reference/lead-attributions/remove-an-attribution-from-a-lead.md)
- [Add a contact to a lead](https://docs.journeybee.io/api-reference/lead-contacts/add-a-contact-to-a-lead.md): Assign a partner contact to a lead. The contact must belong to the same partnership as the lead.
- [List contacts on a lead](https://docs.journeybee.io/api-reference/lead-contacts/list-contacts-on-a-lead.md): Returns partner contacts assigned to a lead. Contacts belong to the lead's partnership.
- [Remove a contact from a lead](https://docs.journeybee.io/api-reference/lead-contacts/remove-a-contact-from-a-lead.md)
- [Remove a custom field value from a lead](https://docs.journeybee.io/api-reference/lead-custom-field-values/remove-a-custom-field-value-from-a-lead.md)
- [Set a custom field value on a lead](https://docs.journeybee.io/api-reference/lead-custom-field-values/set-a-custom-field-value-on-a-lead.md)
- [Update a custom field value on a lead](https://docs.journeybee.io/api-reference/lead-custom-field-values/update-a-custom-field-value-on-a-lead.md)
- [Assign a distributor to a lead](https://docs.journeybee.io/api-reference/lead-distributor/assign-a-distributor-to-a-lead.md)
- [Get the assigned distributor for a lead](https://docs.journeybee.io/api-reference/lead-distributor/get-the-assigned-distributor-for-a-lead.md)
- [Remove the assigned distributor from a lead](https://docs.journeybee.io/api-reference/lead-distributor/remove-the-assigned-distributor-from-a-lead.md)
- [Create a note on a lead](https://docs.journeybee.io/api-reference/lead-notes/create-a-note-on-a-lead.md)
- [Delete a note from a lead](https://docs.journeybee.io/api-reference/lead-notes/delete-a-note-from-a-lead.md)
- [List notes for a lead](https://docs.journeybee.io/api-reference/lead-notes/list-notes-for-a-lead.md)
- [Add a product to a lead](https://docs.journeybee.io/api-reference/lead-products/add-a-product-to-a-lead.md): Add a product from the catalog to a lead. Returns 409 if the lead has a quote attached (products become read-only when managed by a quote).
- [List products on a lead](https://docs.journeybee.io/api-reference/lead-products/list-products-on-a-lead.md): Returns all products attached to a lead, including both manually added products and products sourced from a quote. The `source` field indicates the origin.
- [Remove a product from a lead](https://docs.journeybee.io/api-reference/lead-products/remove-a-product-from-a-lead.md): Remove a manually added product from a lead. Returns 409 if the lead has a quote attached. Only manual products can be removed (not quote-sourced).
- [Update a product on a lead](https://docs.journeybee.io/api-reference/lead-products/update-a-product-on-a-lead.md): Update quantity or price override for a manually added product. Returns 409 if the lead has a quote attached. Only manual products can be updated (not quote-sourced).
- [Delete the quote from a lead](https://docs.journeybee.io/api-reference/lead-quotes/delete-the-quote-from-a-lead.md): Removes the quote and all its line items from a lead. Also removes any quote-sourced products from the lead, restoring manual product management.
- [Get the quote for a lead](https://docs.journeybee.io/api-reference/lead-quotes/get-the-quote-for-a-lead.md): Returns the quote attached to a lead with all line items, currency, and pricing calculator reference. Returns null if no quote exists.
- [Add a tag to a lead](https://docs.journeybee.io/api-reference/lead-tags/add-a-tag-to-a-lead.md)
- [Remove a tag from a lead](https://docs.journeybee.io/api-reference/lead-tags/remove-a-tag-from-a-lead.md)
- [Create a task on a lead](https://docs.journeybee.io/api-reference/lead-tasks/create-a-task-on-a-lead.md): Creates a task attached to this lead. Equivalent to POST /v1/tasks with lead_uuid set.
- [List tasks for a lead](https://docs.journeybee.io/api-reference/lead-tasks/list-tasks-for-a-lead.md)
- [Assign a user to a lead](https://docs.journeybee.io/api-reference/lead-users/assign-a-user-to-a-lead.md)
- [Remove an assigned user from a lead](https://docs.journeybee.io/api-reference/lead-users/remove-an-assigned-user-from-a-lead.md)
- [Archive a lead](https://docs.journeybee.io/api-reference/leads/archive-a-lead.md)
- [Create a lead](https://docs.journeybee.io/api-reference/leads/create-a-lead.md)
- [Get a lead](https://docs.journeybee.io/api-reference/leads/get-a-lead.md)
- [List leads](https://docs.journeybee.io/api-reference/leads/list-leads.md)
- [Update a lead](https://docs.journeybee.io/api-reference/leads/update-a-lead.md)
- [Archive a marketing email template](https://docs.journeybee.io/api-reference/marketing-templates/archive-a-marketing-email-template.md)
- [Create a marketing email template](https://docs.journeybee.io/api-reference/marketing-templates/create-a-marketing-email-template.md): Create the actual marketing EMAIL — a "campaign email" / email template: the content recipients see (header, body, footer blocks). Distinct from a campaign, which only references a template and defines its audience. Seeded with empty content; name, subject, and channel are optional. To build its blo…
- [Get a marketing email template](https://docs.journeybee.io/api-reference/marketing-templates/get-a-marketing-email-template.md)
- [List marketing email templates](https://docs.journeybee.io/api-reference/marketing-templates/list-marketing-email-templates.md): List email templates with optional search. Each template reports how many campaigns reference it. Block content is edited through the in-app builder, not the API.
- [Update a marketing email template](https://docs.journeybee.io/api-reference/marketing-templates/update-a-marketing-email-template.md): Update template metadata: name, subject, channel, partner visibility, and live status. Block content is edited through the in-app builder, not the API.
- [Create a contact for a partner](https://docs.journeybee.io/api-reference/partner-contacts/create-a-contact-for-a-partner.md)
- [Delete a contact](https://docs.journeybee.io/api-reference/partner-contacts/delete-a-contact.md)
- [List contacts for a partner](https://docs.journeybee.io/api-reference/partner-contacts/list-contacts-for-a-partner.md)
- [Update a contact](https://docs.journeybee.io/api-reference/partner-contacts/update-a-contact.md)
- [Remove a custom field value from a partner](https://docs.journeybee.io/api-reference/partner-custom-field-values/remove-a-custom-field-value-from-a-partner.md)
- [Set a custom field value on a partner](https://docs.journeybee.io/api-reference/partner-custom-field-values/set-a-custom-field-value-on-a-partner.md)
- [Update a custom field value on a partner](https://docs.journeybee.io/api-reference/partner-custom-field-values/update-a-custom-field-value-on-a-partner.md)
- [Add a domain to a partner](https://docs.journeybee.io/api-reference/partner-domains/add-a-domain-to-a-partner.md)
- [Remove a domain from a partner](https://docs.journeybee.io/api-reference/partner-domains/remove-a-domain-from-a-partner.md)
- [Create a note on a partner](https://docs.journeybee.io/api-reference/partner-notes/create-a-note-on-a-partner.md)
- [Delete a note from a partner](https://docs.journeybee.io/api-reference/partner-notes/delete-a-note-from-a-partner.md)
- [List notes for a partner](https://docs.journeybee.io/api-reference/partner-notes/list-notes-for-a-partner.md)
- [Assign a reseller to a distributor](https://docs.journeybee.io/api-reference/partner-resellers/assign-a-reseller-to-a-distributor.md)
- [List resellers assigned to a distributor](https://docs.journeybee.io/api-reference/partner-resellers/list-resellers-assigned-to-a-distributor.md)
- [Remove a reseller from a distributor](https://docs.journeybee.io/api-reference/partner-resellers/remove-a-reseller-from-a-distributor.md)
- [Create a partner stage](https://docs.journeybee.io/api-reference/partner-stages/create-a-partner-stage.md)
- [Delete a partner stage](https://docs.journeybee.io/api-reference/partner-stages/delete-a-partner-stage.md)
- [List partner stages](https://docs.journeybee.io/api-reference/partner-stages/list-partner-stages.md)
- [Update a partner stage](https://docs.journeybee.io/api-reference/partner-stages/update-a-partner-stage.md)
- [Add a tag to a partner](https://docs.journeybee.io/api-reference/partner-tags/add-a-tag-to-a-partner.md)
- [Remove a tag from a partner](https://docs.journeybee.io/api-reference/partner-tags/remove-a-tag-from-a-partner.md)
- [Assign a user to a partner](https://docs.journeybee.io/api-reference/partner-users/assign-a-user-to-a-partner.md)
- [Remove a user from a partner](https://docs.journeybee.io/api-reference/partner-users/remove-a-user-from-a-partner.md)
- [Archive a partner](https://docs.journeybee.io/api-reference/partners/archive-a-partner.md): Soft-deletes a partner by setting archived_at. The partner will no longer appear in list results unless include_archived is set.
- [Create a partner](https://docs.journeybee.io/api-reference/partners/create-a-partner.md)
- [Get a partner](https://docs.journeybee.io/api-reference/partners/get-a-partner.md)
- [List partners](https://docs.journeybee.io/api-reference/partners/list-partners.md)
- [Update a partner](https://docs.journeybee.io/api-reference/partners/update-a-partner.md)
- [Add a field to a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-fields/add-a-field-to-a-pricing-calculator.md)
- [Remove a field from a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-fields/remove-a-field-from-a-pricing-calculator.md)
- [Update a field on a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-fields/update-a-field-on-a-pricing-calculator.md)
- [Add a formula to a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-formulas/add-a-formula-to-a-pricing-calculator.md)
- [Remove a formula from a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-formulas/remove-a-formula-from-a-pricing-calculator.md)
- [Update a formula on a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-formulas/update-a-formula-on-a-pricing-calculator.md)
- [Add a product to a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-products/add-a-product-to-a-pricing-calculator.md)
- [Remove a product from a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-products/remove-a-product-from-a-pricing-calculator.md)
- [Update a product on a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculator-products/update-a-product-on-a-pricing-calculator.md)
- [Archive a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculators/archive-a-pricing-calculator.md)
- [Create a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculators/create-a-pricing-calculator.md)
- [Get a pricing calculator with fields, products, and formulas](https://docs.journeybee.io/api-reference/pricing-calculators/get-a-pricing-calculator-with-fields-products-and-formulas.md)
- [List pricing calculators](https://docs.journeybee.io/api-reference/pricing-calculators/list-pricing-calculators.md)
- [Update a pricing calculator](https://docs.journeybee.io/api-reference/pricing-calculators/update-a-pricing-calculator.md)
- [Archive a product](https://docs.journeybee.io/api-reference/products/archive-a-product.md)
- [Create a product](https://docs.journeybee.io/api-reference/products/create-a-product.md)
- [Get a product](https://docs.journeybee.io/api-reference/products/get-a-product.md)
- [List products](https://docs.journeybee.io/api-reference/products/list-products.md)
- [Update a product](https://docs.journeybee.io/api-reference/products/update-a-product.md)
- [Add a block to a resource](https://docs.journeybee.io/api-reference/resource-blocks/add-a-block-to-a-resource.md)
- [List blocks for a resource](https://docs.journeybee.io/api-reference/resource-blocks/list-blocks-for-a-resource.md)
- [Remove a block from a resource](https://docs.journeybee.io/api-reference/resource-blocks/remove-a-block-from-a-resource.md)
- [Update a resource block](https://docs.journeybee.io/api-reference/resource-blocks/update-a-resource-block.md)
- [Add a category to a resource](https://docs.journeybee.io/api-reference/resource-categories/add-a-category-to-a-resource.md)
- [Remove a category from a resource](https://docs.journeybee.io/api-reference/resource-categories/remove-a-category-from-a-resource.md)
- [Add a resource to a folder](https://docs.journeybee.io/api-reference/resource-folders/add-a-resource-to-a-folder.md)
- [Remove a resource from a folder](https://docs.journeybee.io/api-reference/resource-folders/remove-a-resource-from-a-folder.md)
- [Add a tag to a resource](https://docs.journeybee.io/api-reference/resource-tags/add-a-tag-to-a-resource.md)
- [Remove a tag from a resource](https://docs.journeybee.io/api-reference/resource-tags/remove-a-tag-from-a-resource.md)
- [Archive a resource](https://docs.journeybee.io/api-reference/resources/archive-a-resource.md)
- [Create a resource](https://docs.journeybee.io/api-reference/resources/create-a-resource.md)
- [Get a resource](https://docs.journeybee.io/api-reference/resources/get-a-resource.md)
- [List resources](https://docs.journeybee.io/api-reference/resources/list-resources.md)
- [Update a resource](https://docs.journeybee.io/api-reference/resources/update-a-resource.md)
- [Add a block to a room](https://docs.journeybee.io/api-reference/room-blocks/add-a-block-to-a-room.md)
- [List blocks for a room](https://docs.journeybee.io/api-reference/room-blocks/list-blocks-for-a-room.md)
- [Remove a block from a room](https://docs.journeybee.io/api-reference/room-blocks/remove-a-block-from-a-room.md)
- [Update a room block](https://docs.journeybee.io/api-reference/room-blocks/update-a-room-block.md)
- [Add a category to a room](https://docs.journeybee.io/api-reference/room-categories/add-a-category-to-a-room.md)
- [Remove a category from a room](https://docs.journeybee.io/api-reference/room-categories/remove-a-category-from-a-room.md)
- [Add a partnership to a room](https://docs.journeybee.io/api-reference/room-partnerships/add-a-partnership-to-a-room.md)
- [Remove a partnership from a room](https://docs.journeybee.io/api-reference/room-partnerships/remove-a-partnership-from-a-room.md)
- [Add a stage to a room](https://docs.journeybee.io/api-reference/room-stages/add-a-stage-to-a-room.md)
- [Remove a stage from a room](https://docs.journeybee.io/api-reference/room-stages/remove-a-stage-from-a-room.md)
- [Add a tag to a room](https://docs.journeybee.io/api-reference/room-tags/add-a-tag-to-a-room.md)
- [Remove a tag from a room](https://docs.journeybee.io/api-reference/room-tags/remove-a-tag-from-a-room.md)
- [Add a tier to a room](https://docs.journeybee.io/api-reference/room-tiers/add-a-tier-to-a-room.md)
- [Remove a tier from a room](https://docs.journeybee.io/api-reference/room-tiers/remove-a-tier-from-a-room.md)
- [Archive a room](https://docs.journeybee.io/api-reference/rooms/archive-a-room.md)
- [Create a room](https://docs.journeybee.io/api-reference/rooms/create-a-room.md)
- [Get a room](https://docs.journeybee.io/api-reference/rooms/get-a-room.md)
- [List rooms](https://docs.journeybee.io/api-reference/rooms/list-rooms.md)
- [Update a room](https://docs.journeybee.io/api-reference/rooms/update-a-room.md)
- [Create a tag](https://docs.journeybee.io/api-reference/tags/create-a-tag.md)
- [Delete a tag](https://docs.journeybee.io/api-reference/tags/delete-a-tag.md)
- [List tags](https://docs.journeybee.io/api-reference/tags/list-tags.md)
- [Update a tag](https://docs.journeybee.io/api-reference/tags/update-a-tag.md)
- [Assign a user to a task](https://docs.journeybee.io/api-reference/task-users/assign-a-user-to-a-task.md)
- [Remove an assigned user from a task](https://docs.journeybee.io/api-reference/task-users/remove-an-assigned-user-from-a-task.md)
- [Archive a task](https://docs.journeybee.io/api-reference/tasks/archive-a-task.md)
- [Create a task](https://docs.journeybee.io/api-reference/tasks/create-a-task.md): Create a task optionally attached to a lead or partnership. Content is plain text that gets converted to rich text internally. Assign users by providing their UUIDs.
- [Get a task](https://docs.journeybee.io/api-reference/tasks/get-a-task.md)
- [List tasks](https://docs.journeybee.io/api-reference/tasks/list-tasks.md): List tasks with optional filtering by status, lead, partnership, or search term. Tasks include assigned users and rich text content.
- [Update a task](https://docs.journeybee.io/api-reference/tasks/update-a-task.md): Update task fields. Content is plain text that gets converted to rich text internally. Use the assigned-users sub-resource to manage assignees.
- [Create a tier](https://docs.journeybee.io/api-reference/tiers/create-a-tier.md)
- [Delete a tier](https://docs.journeybee.io/api-reference/tiers/delete-a-tier.md)
- [List tiers](https://docs.journeybee.io/api-reference/tiers/list-tiers.md)
- [Update a tier](https://docs.journeybee.io/api-reference/tiers/update-a-tier.md)
- [List company users](https://docs.journeybee.io/api-reference/users/list-company-users.md): Returns users in the company. Use the UUID when assigning users to leads, tasks, or partners.
- [Deal created](https://docs.journeybee.io/api-reference/webhook-events/deal-created.md): Fired when a new deal is created.
- [Deal deleted](https://docs.journeybee.io/api-reference/webhook-events/deal-deleted.md): Fired when a deal is deleted.
- [Deal note created](https://docs.journeybee.io/api-reference/webhook-events/deal-note-created.md): Fired when a note is added to a deal.
- [Deal note deleted](https://docs.journeybee.io/api-reference/webhook-events/deal-note-deleted.md): Fired when a deal note is removed.
- [Deal note updated](https://docs.journeybee.io/api-reference/webhook-events/deal-note-updated.md): Fired when a deal note is updated.
- [Deal updated](https://docs.journeybee.io/api-reference/webhook-events/deal-updated.md): Fired when a deal is updated.
- [Lead created](https://docs.journeybee.io/api-reference/webhook-events/lead-created.md): Fired when a new lead is created.
- [Lead deleted](https://docs.journeybee.io/api-reference/webhook-events/lead-deleted.md): Fired when a lead is deleted.
- [Lead note created](https://docs.journeybee.io/api-reference/webhook-events/lead-note-created.md): Fired when a note is added to a lead.
- [Lead note deleted](https://docs.journeybee.io/api-reference/webhook-events/lead-note-deleted.md): Fired when a note is removed from a lead.
- [Lead updated](https://docs.journeybee.io/api-reference/webhook-events/lead-updated.md): Fired when a lead is updated.
- [Message created](https://docs.journeybee.io/api-reference/webhook-events/message-created.md): Fired when a message is sent.
- [Partner contact created](https://docs.journeybee.io/api-reference/webhook-events/partner-contact-created.md): Fired when a contact is added to a partner.
- [Partner contact updated](https://docs.journeybee.io/api-reference/webhook-events/partner-contact-updated.md): Fired when a partner contact is updated.
- [Partner created](https://docs.journeybee.io/api-reference/webhook-events/partner-created.md): Fired when a new partner is created.
- [Partner updated](https://docs.journeybee.io/api-reference/webhook-events/partner-updated.md): Fired when a partner is updated.
- [Authentication](https://docs.journeybee.io/guides/authentication.md): How to authenticate with the Journeybee API
- [Changelog](https://docs.journeybee.io/guides/changelog.md): API versioning and recent changes
- [Embedded Lead Forms](https://docs.journeybee.io/guides/embedding-forms.md): Embed a Journeybee lead-capture form on any website with a single script tag
- [Embedded Partner Portal](https://docs.journeybee.io/guides/embedding-portal.md): Embed the authenticated partner portal inside your own app with a backend-minted SSO token
- [Error Handling](https://docs.journeybee.io/guides/errors.md): Error codes and handling in the Journeybee API
- [Idempotency](https://docs.journeybee.io/guides/idempotency.md): Safely retry POST requests without creating duplicate resources
- [MCP Server](https://docs.journeybee.io/guides/mcp.md): Connect AI assistants to Journeybee via the Model Context Protocol
- [Pagination](https://docs.journeybee.io/guides/pagination.md): How pagination works in the Journeybee API
- [TypeScript SDK](https://docs.journeybee.io/guides/sdk.md): Install and use the Journeybee TypeScript SDK
- [Webhooks](https://docs.journeybee.io/guides/webhooks.md): Subscribe to real-time events from your Journeybee workspace
- [Journeybee API](https://docs.journeybee.io/index.md): Build integrations with the Journeybee PRM platform

## OpenAPI Specs

- [openapi](https://docs.journeybee.io/openapi.json)