> ## 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 Custom Field

> Get a custom field by ID, including all of its mappings (organization- and connector-scoped).



## OpenAPI

````yaml get /api/v1/custom-fields/{custom_field_id}
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/{custom_field_id}:
    get:
      tags:
        - Custom Fields
      summary: Get Custom Field
      description: Get a custom field with all its mappings.
      operationId: get_custom_field_api_v1_custom_fields__custom_field_id__get
      parameters:
        - name: custom_field_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Custom Field Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldDetailExternal'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    CustomFieldDetailExternal:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique identifier of the custom field.
          examples:
            - 018e586b-7d0b-7bc9-be65-a8fdbc82d734
        name:
          type: string
          title: Name
          description: Name of the custom field (snake_case).
          examples:
            - guardian_mobile
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description of the custom field.
          examples:
            - Employee's guardian mobile number
        category:
          $ref: '#/components/schemas/Category'
          description: Category of the model.
          examples:
            - HRIS
        model:
          type: string
          title: Model
          description: Model on which the custom field is applied.
          examples:
            - employee
        source:
          $ref: '#/components/schemas/CustomFieldSource'
          description: >-
            Origin of the custom field. 'API' if created through the public API,
            'DASHBOARD' if created from the Bindbee dashboard.
          examples:
            - API
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
        mappings:
          items:
            $ref: '#/components/schemas/CustomFieldMappingExternal'
          type: array
          title: Mappings
          description: All mappings configured for this custom field.
      type: object
      required:
        - id
        - name
        - category
        - model
        - source
        - created_at
      title: CustomFieldDetailExternal
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Category:
      type: string
      enum:
        - HRIS
        - ATS
        - LMS
      title: Category
    CustomFieldSource:
      type: string
      enum:
        - DASHBOARD
        - API
      title: CustomFieldSource
    CustomFieldMappingExternal:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique identifier of the mapping.
          examples:
            - 018e586b-7d0b-7bc9-be65-a8fdbc82d734
        custom_field_id:
          type: string
          format: uuid
          title: Custom Field Id
          description: ID of the custom field this mapping belongs to.
          examples:
            - 018e586b-7d0b-7bc9-be65-a8fdbc82d734
        integration_slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Integration Slug
          description: >-
            Integration slug. Set when the mapping is organization-scoped; null
            otherwise.
          examples:
            - workday
        connector_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Connector Token
          description: >-
            Connector token. Set when the mapping is connector-scoped; null
            otherwise.
          examples:
            - i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T
        json_path:
          type: string
          title: Json Path
          description: >-
            JMESPath expression used to extract the value from the upstream
            payload.
          examples:
            - data.employee.guardian_mobile
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - custom_field_id
        - json_path
        - created_at
      title: CustomFieldMappingExternal
    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

````