> ## Documentation Index > Fetch the complete documentation index at: https://docs.journeybee.io/llms.txt > Use this file to discover all available pages before exploring further. # Get the lead status forms > 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`. ## OpenAPI ````yaml /openapi.json get /leads/status-forms openapi: 3.1.0 info: title: Journeybee API description: >- Public REST API for the Journeybee PRM platform. Manage partners, leads, deals, products, pricing calculators, tasks, and more programmatically. All endpoints require authentication via API key. Use `Authorization: Bearer ` or `Api-Key ` header. See the [Authentication guide](/guides/authentication) for details. version: 1.0.0 servers: - url: https://api.journeybee.io/v1 description: Production security: - apiKey: [] tags: - name: Account description: >- Authenticated company account info, API key permissions, and enabled modules - name: Agreement Templates - name: Agreements - name: Analytics description: >- Dashboard analytics and reporting — commission, engagement, LMS, and partner revenue metrics - name: Assets description: File and media asset management - name: Attributions description: Attribution type definitions - name: Audit Log description: Unified audit log of company activity (read-only) - name: Automations description: Workflow automation rule configurations - name: Campaign Audience description: Audience filters on a campaign - name: Campaign Partners description: Partners shared into a campaign audience - name: Campaigns description: Partner marketing campaigns - name: Card Assignees description: Assigned users on a card - name: Card Partners description: Partners linked to a card - name: Card Tags description: Tags on a card - name: Cards description: Kanban project cards - name: Categories description: Partner categories - name: Certification Categories description: Categories on a certification - name: Certification Enrollments description: User enrollments in a certification - name: Certification Folders description: Folders on a certification - name: Certification Resources description: Curriculum resources in a certification - name: Certifications description: LMS certifications - name: Commissions description: >- Commission rule configurations with calculation entries, tier/category/partnership scoping - name: Contacts description: Partner contacts across partnerships - name: Currencies description: Available currencies - name: Custom Field Options description: Options on select/multi-select custom fields - name: Custom Field Rules description: Visibility and requirement rules on custom fields - name: Custom Field Values description: Custom field values - name: Custom Fields description: Custom field definitions - name: Deal Commission description: Commission calculation on a deal - name: Deal Custom Field Values description: Custom field values on a deal - name: Deal Notes description: Notes on a deal - name: Deal Partner Roles description: Roles a supporting (co-sell) partner can hold on a deal - name: Deal Partners description: Supporting (co-sell) partners on a deal - name: Deal Payments description: Payment records on a deal (read-only) - name: Deal Products description: Products attached to a deal - name: Deal Stages description: Deal pipeline stages - name: Deal Tags description: Tags on a deal - name: Deal Tasks description: Tasks on a deal - name: Deals description: Deal management - name: Event Subscriptions - name: Event Types - name: Folders description: Content folders - name: Integrations description: Company integration settings - name: Lead Attributions description: Attribution records on a lead - name: Lead Contacts description: Partner contacts on a lead - name: Lead Custom Field Values description: Custom field values on a lead - name: Lead Distributor description: Distributors for a lead - name: Lead Notes description: Notes on a lead - name: Lead Products description: Products attached to a lead - name: Lead Quotes description: >- Quotes on a lead — generated from pricing calculators with line items and totals - name: Lead Tags description: Tags on a lead - name: Lead Tasks description: Tasks on a lead - name: Lead Users description: Assigned users on a lead - name: Leads description: Lead management - name: Marketing Templates description: Marketing email templates - name: Partner Contacts description: Contacts on a partner - name: Partner Custom Field Values description: Custom field values on a partner - name: Partner Domains description: Domains on a partner - name: Partner Notes description: Notes on a partner - name: Partner Resellers description: Reseller assignments on a distributor - name: Partner Stages description: Partner pipeline stages - name: Partner Tags description: Tags on a partner - name: Partner Users description: Assigned users on a partner - name: Partners description: Core partner CRUD - name: Pricing Calculator Fields description: Input fields on a pricing calculator - name: Pricing Calculator Formulas description: Discount/tax/surcharge formulas on a pricing calculator - name: Pricing Calculator Products description: Products attached to a pricing calculator - name: Pricing Calculators description: Pricing calculator configurations - name: Products description: Product catalog - name: Resource Blocks description: Content blocks within a resource - name: Resource Categories description: Categories on a resource - name: Resource Folders description: Folders on a resource - name: Resource Tags description: Tags on a resource - name: Resources description: Learning resources - name: Room Blocks description: Content blocks within a room - name: Room Categories description: Category-based room access control - name: Room Partnerships description: Direct partnership room access - name: Room Secure Files description: >- Private files in a secure_files room block: folders, multipart uploads, signed download links and download history - name: Room Stages description: Stage-based room access control - name: Room Tags description: Tag-based room access control - name: Room Tiers description: Tier-based room access control - name: Rooms description: Partner portal rooms - name: Tags description: Tag definitions - name: Task Users description: Assigned users on a task - name: Tasks description: Task management - name: Tiers description: Partner tiers - name: Users description: Company team members - name: Webhook Events description: Outbound webhook payloads sent to your configured URLs when events occur paths: /leads/status-forms: get: tags: - Leads summary: 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`. operationId: getLeadStatusForms responses: '200': description: Default Response content: application/json: schema: type: object properties: converted: type: object properties: mode: type: string enum: - 'off' - optional - required description: >- off: no form. optional: the fields and reason may be sent with the status change. required: every required field and a required reason must be sent with the status change, or updateLead is refused with 400 validation_error naming each missing one. category: type: string enum: - lead_acceptance - lead_rejection description: Custom field category of this form's fields. fields: type: array items: type: object properties: uuid: type: string label: type: string type: type: string enum: - text - textarea - email - website - phone - number - date - boolean - checkbox - select - multi_select category: type: string enum: - lead - partner - lead_deal - contact - lead_acceptance - lead_rejection description: >- Entity the field belongs to: partner, lead, lead_deal or contact. lead_acceptance and lead_rejection are the forms filled in when a lead moves to Accepted (status converted) or Rejected; their values belong to the lead. Status-form fields are one form per company: partner_type does not apply to them. partner_type: anyOf: - type: string enum: - referral - reseller - distributor - type: 'null' description: >- Which partner type can see this field. On lead_acceptance / lead_rejection fields it is a stored default with no effect. options: anyOf: - type: array items: type: object properties: id: type: number label: type: string required: - id - label additionalProperties: false - type: 'null' description: anyOf: - type: string - type: 'null' link_url: anyOf: - type: string - type: 'null' link_label: anyOf: - type: string - type: 'null' shared: type: boolean required: type: boolean created_at: type: string updated_at: type: string required: - uuid - label - type - category - partner_type - options - description - link_url - link_label - shared - required - created_at - updated_at additionalProperties: false description: >- The form's fields in form order. Send their values by uuid in updateLead's custom_fields together with the status change. `required` binds only when mode is required; `shared` fields are also shown to the partner. reason: type: object properties: field: type: string enum: - accepted_reason - rejected_reason description: >- The updateLead body field that carries this form's reason. required: type: boolean description: >- True when the reason must be sent with the status change (mode required and the company requires it). visible_to_partner: type: boolean description: >- True when the partner sees the reason in the portal and notifications. required: - field - required - visible_to_partner additionalProperties: false required: - mode - category - fields - reason additionalProperties: false description: The Accepted form, applied when a lead moves to converted. rejected: type: object properties: mode: type: string enum: - 'off' - optional - required description: >- off: no form. optional: the fields and reason may be sent with the status change. required: every required field and a required reason must be sent with the status change, or updateLead is refused with 400 validation_error naming each missing one. category: type: string enum: - lead_acceptance - lead_rejection description: Custom field category of this form's fields. fields: type: array items: type: object properties: uuid: type: string label: type: string type: type: string enum: - text - textarea - email - website - phone - number - date - boolean - checkbox - select - multi_select category: type: string enum: - lead - partner - lead_deal - contact - lead_acceptance - lead_rejection description: >- Entity the field belongs to: partner, lead, lead_deal or contact. lead_acceptance and lead_rejection are the forms filled in when a lead moves to Accepted (status converted) or Rejected; their values belong to the lead. Status-form fields are one form per company: partner_type does not apply to them. partner_type: anyOf: - type: string enum: - referral - reseller - distributor - type: 'null' description: >- Which partner type can see this field. On lead_acceptance / lead_rejection fields it is a stored default with no effect. options: anyOf: - type: array items: type: object properties: id: type: number label: type: string required: - id - label additionalProperties: false - type: 'null' description: anyOf: - type: string - type: 'null' link_url: anyOf: - type: string - type: 'null' link_label: anyOf: - type: string - type: 'null' shared: type: boolean required: type: boolean created_at: type: string updated_at: type: string required: - uuid - label - type - category - partner_type - options - description - link_url - link_label - shared - required - created_at - updated_at additionalProperties: false description: >- The form's fields in form order. Send their values by uuid in updateLead's custom_fields together with the status change. `required` binds only when mode is required; `shared` fields are also shown to the partner. reason: type: object properties: field: type: string enum: - accepted_reason - rejected_reason description: >- The updateLead body field that carries this form's reason. required: type: boolean description: >- True when the reason must be sent with the status change (mode required and the company requires it). visible_to_partner: type: boolean description: >- True when the partner sees the reason in the portal and notifications. required: - field - required - visible_to_partner additionalProperties: false required: - mode - category - fields - reason additionalProperties: false description: The Rejected form, applied when a lead moves to rejected. required: - converted - rejected additionalProperties: false components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.