---
title: "ByCustomFieldSelector"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/ByCustomFieldSelector"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# ByCustomFieldSelector

Entity selector that include entities by a custom field.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    StringSelectorOperator:
      type: string
      enum:
        - eq
        - contains
    NumberSelectorOperator:
      type: string
      enum:
        - eq
        - lt
        - gt
    BooleanSelectorOperator:
      type: string
      enum:
        - eq
    ByCustomFieldSelector:
      type: object
      description: Entity selector that include entities by a custom field.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - custom_field
        selector_parameters:
          oneOf:
            - type: object
              title: StringCustomFieldSelectorParams
              required:
                - field
                - value
                - operator
              properties:
                field:
                  type: string
                  description: Name of the custom field.
                value:
                  type: string
                operator:
                  $ref: "#/components/schemas/StringSelectorOperator"
            - type: object
              title: NumberCustomFieldSelectorParams
              required:
                - field
                - value
                - operator
              properties:
                field:
                  type: string
                  description: Name of the custom field.
                value:
                  type: number
                operator:
                  $ref: "#/components/schemas/NumberSelectorOperator"
            - type: object
              title: BooleanCustomFieldSelectorParams
              required:
                - field
                - value
                - operator
              properties:
                field:
                  type: string
                  description: Name of the custom field.
                value:
                  type: boolean
                operator:
                  $ref: "#/components/schemas/BooleanSelectorOperator"
            - type: object
              title: UrlCustomFieldSelectorParams
              required:
                - field
                - subfield
                - value
                - operator
              properties:
                field:
                  type: string
                  description: Name of the custom field.
                subfield:
                  type: string
                  enum:
                    - name
                    - link
                  description: Specify which subfield of the `url` custom field value to use for
                    selection.
                value:
                  type: string
                operator:
                  $ref: "#/components/schemas/StringSelectorOperator"
```