> ## 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.

# List Mappings

> List custom field mappings for an integration (org-scoped) or a connector (connector-scoped). Provide exactly one of `integration_slug` or `connector_token`.



## OpenAPI

````yaml get /api/v1/custom-fields/mapping
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/mapping:
    get:
      tags:
        - Custom Fields
      summary: List Custom Field Mappings
      description: >-
        List mappings for an integration slug or connector token. Provide
        exactly one of `integration_slug` or `connector_token`.
      operationId: list_custom_field_mappings_api_v1_custom_fields_mapping_get
      parameters:
        - name: integration_slug
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Integration slug — return organization-scoped mappings for this
              integration.
            examples:
              - workday
            title: Integration Slug
          description: >-
            Integration slug — return organization-scoped mappings for this
            integration.
        - name: connector_token
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Connector token — return connector-scoped mappings for this
              connector.
            examples:
              - i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T
            title: Connector Token
          description: >-
            Connector token — return connector-scoped mappings for this
            connector.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFieldMappingExternal'
                title: >-
                  Response List Custom Field Mappings Api V1 Custom Fields
                  Mapping Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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

````