> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bindbee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Configuration

> Return the full custom-field configuration for a connector + (category, model): every field with its effective mapping (connector overrides organization). Unmapped fields are included with `json_path: null` so callers can see what is left to configure.



## OpenAPI

````yaml get /api/v1/custom-fields/configuration
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers:
  - url: https://api.bindbee.dev
  - url: https://api-eu.bindbee.dev
security: []
paths:
  /api/v1/custom-fields/configuration:
    get:
      tags:
        - Custom Fields
      summary: Get Custom Fields Configuration
      description: >-
        For a connector + (category, model), return the full custom-field
        configuration: every custom field with its effective mapping (connector
        overrides organization) and the source. Unmapped fields are included
        with null json_path so callers can see what is left to configure.
      operationId: get_custom_fields_configuration_api_v1_custom_fields_configuration_get
      parameters:
        - name: connector_token
          in: query
          required: true
          schema:
            type: string
            description: Connector token to compute the configuration for.
            examples:
              - i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T
            title: Connector Token
          description: Connector token to compute the configuration for.
        - name: category
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/Category'
            description: Category to filter custom fields by.
            examples:
              - HRIS
          description: Category to filter custom fields by.
        - name: model
          in: query
          required: true
          schema:
            type: string
            maxLength: 64
            pattern: ^[a-z][a-z0-9_-]*$
            description: Model slug to filter custom fields by.
            examples:
              - employee
            title: Model
          description: Model slug to filter custom fields by.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EffectiveCustomFieldResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    Category:
      type: string
      enum:
        - HRIS
        - ATS
        - LMS
      title: Category
    EffectiveCustomFieldResponse:
      properties:
        connector_token:
          type: string
          title: Connector Token
          description: Connector the effective view was computed for.
        integration_slug:
          type: string
          title: Integration Slug
          description: Slug of the integration this connector belongs to.
          examples:
            - workday
        category:
          $ref: '#/components/schemas/Category'
          description: Category filter applied.
          examples:
            - HRIS
        model:
          type: string
          title: Model
          description: Model filter applied.
          examples:
            - employee
        fields:
          items:
            $ref: '#/components/schemas/EffectiveCustomFieldEntry'
          type: array
          title: Fields
          description: >-
            Every custom field for this org matching (category, model), with the
            effective mapping per field. Includes unmapped fields so callers can
            see what is left to configure.
      type: object
      required:
        - connector_token
        - integration_slug
        - category
        - model
        - fields
      title: EffectiveCustomFieldResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EffectiveCustomFieldEntry:
      properties:
        custom_field_id:
          type: string
          format: uuid
          title: Custom Field Id
          description: ID of the custom field.
          examples:
            - 018e586b-7d0b-7bc9-be65-a8fdbc82d734
        name:
          type: string
          title: Name
          description: Name of the custom field.
          examples:
            - guardian_mobile
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description of the custom field.
        category:
          $ref: '#/components/schemas/Category'
          description: Category of the model.
          examples:
            - HRIS
        model:
          type: string
          title: Model
          description: Model the custom field is applied to.
          examples:
            - employee
        json_path:
          anyOf:
            - type: string
            - type: 'null'
          title: Json Path
          description: >-
            The effective JMESPath in use for this field on this connector. Null
            when no mapping exists.
          examples:
            - data.employee.guardian_mobile
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            Which mapping is in effect: 'connector' (connector-scoped override),
            'organization' (org-scoped inherited), or null (no mapping
            configured).
          examples:
            - connector
        mapping_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Mapping Id
          description: ID of the underlying mapping row, for editing. Null when unmapped.
          examples:
            - 018e586b-7d0b-7bc9-be65-a8fdbc82d734
      type: object
      required:
        - custom_field_id
        - name
        - category
        - model
      title: EffectiveCustomFieldEntry
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````