> ## 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 lead custom field requirements

> Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy.



## OpenAPI

````yaml /partner-openapi.json get /partner/{partnershipId}/leads/requirements
openapi: 3.1.0
info:
  title: Journeybee Partner API
  description: Partner-facing REST API for the Journeybee PRM platform.
  version: 1.0.0
servers:
  - url: https://api.journeybee.io/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Partner
    description: Partner-facing API endpoints — used only by the partner spec
paths:
  /partner/{partnershipId}/leads/requirements:
    get:
      tags:
        - Partner
      summary: Get lead custom field requirements
      description: >-
        Returns the custom fields and rules that createPartnerLead and
        updatePartnerLead enforce for this partnership — the fields (with their
        required flag) and active rules (visibility, locking, auto-population) a
        lead submission must satisfy.
      operationId: getPartnerLeadRequirements
      parameters:
        - 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)$
          in: path
          name: partnershipId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        type:
                          type: string
                          enum:
                            - text
                            - textarea
                            - number
                            - date
                            - boolean
                            - select
                            - multi_select
                        required:
                          type: boolean
                        options:
                          anyOf:
                            - type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  label:
                                    type: string
                                required:
                                  - id
                                  - label
                                additionalProperties: false
                            - type: 'null'
                      required:
                        - id
                        - label
                        - type
                        - required
                        - options
                      additionalProperties: false
                  rules:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        action_type:
                          type: string
                          enum:
                            - set_value
                            - show_field
                            - value_mapping
                        source_field:
                          type: string
                        source_values:
                          type: array
                          items:
                            anyOf:
                              - type: string
                              - type: number
                              - type: boolean
                        target_field:
                          type: string
                        target_value:
                          anyOf:
                            - type: object
                              properties:
                                text:
                                  description: Value for text/url/email/phone fields
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                number:
                                  description: Value for number fields
                                  anyOf:
                                    - anyOf:
                                        - type: number
                                        - type: string
                                    - type: 'null'
                                date:
                                  description: Value for date fields (ISO 8601 date string)
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                boolean:
                                  description: Value for checkbox fields
                                  anyOf:
                                    - anyOf:
                                        - type: boolean
                                        - type: string
                                    - type: 'null'
                                select:
                                  description: Option ID for single-select fields
                                  anyOf:
                                    - type: number
                                    - type: 'null'
                                multi_select:
                                  description: Option IDs for multi-select fields
                                  anyOf:
                                    - type: array
                                      items:
                                        type: number
                                    - type: 'null'
                              additionalProperties: false
                              description: >-
                                Custom field value. Set the key matching the
                                field type: text (text/url/email/phone), number,
                                date, boolean (checkbox), select (option ID), or
                                multi_select (array of option IDs).
                            - type: 'null'
                        value_mappings:
                          anyOf:
                            - type: array
                              items:
                                type: object
                                properties:
                                  sourceValue:
                                    anyOf:
                                      - type: string
                                      - type: number
                                      - type: boolean
                                  targetValue:
                                    type: object
                                    properties:
                                      text:
                                        description: Value for text/url/email/phone fields
                                        anyOf:
                                          - type: string
                                          - type: 'null'
                                      number:
                                        description: Value for number fields
                                        anyOf:
                                          - anyOf:
                                              - type: number
                                              - type: string
                                          - type: 'null'
                                      date:
                                        description: >-
                                          Value for date fields (ISO 8601 date
                                          string)
                                        anyOf:
                                          - type: string
                                          - type: 'null'
                                      boolean:
                                        description: Value for checkbox fields
                                        anyOf:
                                          - anyOf:
                                              - type: boolean
                                              - type: string
                                          - type: 'null'
                                      select:
                                        description: Option ID for single-select fields
                                        anyOf:
                                          - type: number
                                          - type: 'null'
                                      multi_select:
                                        description: Option IDs for multi-select fields
                                        anyOf:
                                          - type: array
                                            items:
                                              type: number
                                          - type: 'null'
                                    additionalProperties: false
                                    description: >-
                                      Custom field value. Set the key matching
                                      the field type: text
                                      (text/url/email/phone), number, date,
                                      boolean (checkbox), select (option ID), or
                                      multi_select (array of option IDs).
                                required:
                                  - sourceValue
                                  - targetValue
                                additionalProperties: false
                            - type: 'null'
                        locked:
                          type: boolean
                      required:
                        - id
                        - label
                        - action_type
                        - source_field
                        - source_values
                        - target_field
                        - target_value
                        - value_mappings
                        - locked
                      additionalProperties: false
                required:
                  - fields
                  - rules
                additionalProperties: false
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

````