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

# List Custom Field Options

> List the available custom field definitions for a team and ticket type. Returns field definitions with empty values. Use this to discover field keys before setting values on tickets.



## OpenAPI

````yaml /sections/api-reference/openapi-spec-v2.yaml get /v2/teams/{team_id}/custom-field-options
openapi: 3.1.0
info:
  title: Serval Public API
  description: Serval Public API
  contact:
    name: Serval
    url: https://serval.com
    email: support@serval.com
  license:
    name: Serval License
    url: https://serval.com/license
  version: 2.0.0
servers:
  - url: https://public.api.serval.com
security:
  - BearerAuth: []
tags:
  - name: Access Policy API
  - name: Access Policy Approval Procedure API
  - name: Access Profile API
  - name: Access Relationship API
  - name: Access Request API
  - name: Agent API
  - name: App Instance API
  - name: App Resource API
  - name: App Resource Role API
  - name: Approval Delegation API
  - name: Approval Request API
  - name: Audit Log API
  - name: Change Blackout API
  - name: Change Model API
  - name: Custom Field API
  - name: Custom Service API
  - name: Entity API
  - name: Entity Field Mapping API
  - name: Entity Ingestion Config API
  - name: Entity Type API
  - name: Folder API
  - name: Group API
  - name: Guidance API
  - name: Help Agent API
  - name: Journey API
  - name: Knowledge API
  - name: Knowledge Base API
  - name: Report API
  - name: SLA API
  - name: Schedule API
  - name: Tag API
  - name: Team API
  - name: Team User API
  - name: Ticket API
  - name: Topic API
  - name: User API
  - name: User Relationship API
  - name: Workflow API
  - name: Workflow Approval Procedure API
  - name: Workflow Run API
paths:
  /v2/teams/{team_id}/custom-field-options:
    get:
      tags:
        - Custom Field API
      summary: List Custom Field Options
      description: >-
        List the available custom field definitions for a team and ticket type.
        Returns field definitions with empty values. Use this to discover field
        keys before setting values on tickets.
      operationId: svrelay.publicv2.PublicAPIServiceV2.ListCustomFieldOptions
      parameters:
        - name: team_id
          in: path
          required: true
          schema:
            type: string
            title: team_id
            description: The ID of the team to list custom field options for.
        - name: ticketType
          in: query
          description: The ticket type to list custom field options for.
          schema:
            $ref: '#/components/schemas/svhelp.models.TicketType'
            title: ticket_type
            description: The ticket type to list custom field options for.
        - name: ticketSubtype
          in: query
          description: |-
            Required for CHANGE tickets — each subtype (normal, standard,
             emergency, custom) has its own field schema. Omit for non-change types.
          schema:
            type: string
            title: ticket_subtype
            description: |-
              Required for CHANGE tickets — each subtype (normal, standard,
               emergency, custom) has its own field schema. Omit for non-change types.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/svhelp.publicapi.ListCustomFieldOptionsResponse
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
      security:
        - BearerAuth: []
components:
  schemas:
    svhelp.models.TicketType:
      type: string
      title: TicketType
      enum:
        - TICKET_TYPE_UNSPECIFIED
        - TICKET_TYPE_REQUEST
        - TICKET_TYPE_TASK
        - TICKET_TYPE_MAJOR_INCIDENT
        - TICKET_TYPE_CONVERSATION
        - TICKET_TYPE_JOURNEY
        - TICKET_TYPE_JOURNEY_CONVERSATION
        - TICKET_TYPE_INCIDENT
        - TICKET_TYPE_CHANGE
        - TICKET_TYPE_CUSTOM
    svhelp.publicapi.ListCustomFieldOptionsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/svhelp.models.CustomFieldValuesResult'
          title: data
          x-stainless-terraform-configurability: optional
      title: ListCustomFieldOptionsResponse
      additionalProperties: false
    connect.error:
      type: object
      properties:
        code:
          type: string
          examples:
            - not_found
          enum:
            - canceled
            - unknown
            - invalid_argument
            - deadline_exceeded
            - not_found
            - already_exists
            - permission_denied
            - resource_exhausted
            - failed_precondition
            - aborted
            - out_of_range
            - unimplemented
            - internal
            - unavailable
            - data_loss
            - unauthenticated
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
          x-stainless-terraform-configurability: optional
        message:
          type: string
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
          x-stainless-terraform-configurability: optional
        detail:
          $ref: '#/components/schemas/google.protobuf.Any'
          x-stainless-terraform-configurability: optional
      title: Connect Error
      additionalProperties: true
      description: >-
        Error type returned by Connect:
        https://connectrpc.com/docs/go/errors/#http-representation
    svhelp.models.CustomFieldValuesResult:
      type: object
      properties:
        activeCustomFields:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.models.CustomFieldValue'
          title: active_custom_fields
          x-stainless-terraform-configurability: optional
        deprecatedCustomFields:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.models.CustomFieldValue'
          title: deprecated_custom_fields
          x-stainless-terraform-configurability: optional
        activeCustomFieldGroups:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.models.CustomFieldGroup'
          title: active_custom_field_groups
          description: >-
            Active custom fields organized by section (svstore
            entity_field_section).
             Always populated and consistent with `active_custom_fields`: the union
             of every group's custom_fields equals active_custom_fields (modulo
             order). Group ordering: the section-unset catch-all group (if any)
             first, then sections by creation order. Use this when rendering one
             container per group on the UI; use `active_custom_fields` when a flat
             list is sufficient.
          x-stainless-terraform-configurability: optional
      title: CustomFieldValuesResult
      additionalProperties: false
    google.protobuf.Any:
      type: object
      properties:
        type:
          type: string
          x-stainless-terraform-configurability: optional
        value:
          type: string
          format: binary
          x-stainless-terraform-configurability: optional
        debug:
          type: object
          additionalProperties: true
          x-stainless-terraform-configurability: optional
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message.
    svhelp.models.CustomFieldValue:
      type: object
      properties:
        fieldValue:
          $ref: '#/components/schemas/svstore.EntityFieldValue'
          title: field_value
          x-stainless-terraform-configurability: optional
        field:
          $ref: '#/components/schemas/svstore.EntityTypeField'
          title: field
          x-stainless-terraform-configurability: optional
      title: CustomFieldValue
      additionalProperties: false
    svhelp.models.CustomFieldGroup:
      type: object
      properties:
        section:
          $ref: '#/components/schemas/svstore.EntityFieldSection'
          title: section
          description: |-
            The section this group corresponds to, or unset for the catch-all
             group of fields with no section assigned.
          nullable: true
          x-stainless-terraform-configurability: optional
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.models.CustomFieldValue'
          title: custom_fields
          x-stainless-terraform-configurability: optional
      title: CustomFieldGroup
      additionalProperties: false
      description: |-
        CustomFieldGroup is a list of active custom fields that share a visual
         grouping (svstore entity_field_section). When `section` is unset, the group
         is the catch-all for fields whose binding has no section assigned.
         Deprecated fields are intentionally excluded; they always surface in a flat
         list outside the grouped UI.
    svstore.EntityFieldValue:
      type: object
      properties:
        id:
          type: string
          title: id
          description: >-
            The EAV row id. NOT populated on entity read paths
            (Entity.field_values:
             search / list / get / create / update) since the v4 slim document_json
             dropped it — it has no consumer there. It IS populated on the
             listEntityFieldValueHistory RPC, which reads EAV rows directly.
          x-stainless-terraform-configurability: optional
        entityId:
          type: string
          title: entity_id
          x-stainless-terraform-configurability: optional
        fieldId:
          type: string
          title: field_id
          x-stainless-terraform-configurability: optional
        fieldKey:
          type: string
          title: field_key
          x-stainless-terraform-configurability: optional
        fieldName:
          type: string
          title: field_name
          x-stainless-terraform-configurability: optional
        dataType:
          $ref: '#/components/schemas/svstore.EntityTypeField.DataType'
          title: data_type
          x-stainless-terraform-configurability: optional
        value:
          $ref: '#/components/schemas/google.protobuf.Value'
          title: value
          description: |-
            The field value as a JSON-compatible value. Type interpretation is
             determined by data_type:
               TEXT, UNIQUE, ENUM, ENTITY_REF, USER_REF → string
               NUMBER → number
               BOOL → bool
               TIMESTAMP → string (ISO 8601, e.g. "2024-03-15T10:30:00Z")
               MULTI_SELECT → list of strings (enum option IDs)
          x-stainless-terraform-configurability: optional
        setByUserId:
          type: string
          title: set_by_user_id
          description: |-
            Attribution: who/what set this field value. Stored in the slim
             document_json and populated on ALL entity read paths (search / list / get
             / create / update) as well as field-value history.
          nullable: true
          x-stainless-terraform-configurability: optional
        setByAppInstanceId:
          type: string
          title: set_by_app_instance_id
          nullable: true
          x-stainless-terraform-configurability: optional
        createdAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
          description: >-
            Temporal context. NOT populated on entity read paths
            (Entity.field_values)
             since the v4 slim document_json dropped created_at — it has no consumer
             there. It IS populated on the listEntityFieldValueHistory RPC. The current
             value for a field has deleted_at unset.
          x-stainless-terraform-configurability: optional
        deletedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: deleted_at
          nullable: true
          x-stainless-terraform-configurability: optional
        pinned:
          type: boolean
          title: pinned
          description: >-
            When true, ingestion cannot overwrite this user-set value. Stored in
            the
             slim document_json and populated on ALL entity read paths.
          x-stainless-terraform-configurability: computed_optional
      title: EntityFieldValue
      additionalProperties: false
      description: |-
        EntityFieldValue represents a concrete field value on a specific entity.
         Used for both current values (on Entity.field_values) and historical values
         (in field value history responses).
    svstore.EntityTypeField:
      type: object
      properties:
        id:
          type: string
          title: id
          x-stainless-terraform-configurability: optional
        entityTypeId:
          type: string
          title: entity_type_id
          x-stainless-terraform-configurability: optional
        key:
          type: string
          title: key
          x-stainless-terraform-configurability: optional
        name:
          type: string
          title: name
          x-stainless-terraform-configurability: optional
        dataType:
          $ref: '#/components/schemas/svstore.EntityTypeField.DataType'
          title: data_type
          x-stainless-terraform-configurability: optional
        createdAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
          x-stainless-terraform-configurability: optional
        updatedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: updated_at
          x-stainless-terraform-configurability: optional
        createdByUserId:
          type: string
          title: created_by_user_id
          x-stainless-terraform-configurability: optional
        updatedByUserId:
          type: string
          title: updated_by_user_id
          x-stainless-terraform-configurability: optional
        enumOptions:
          type: array
          items:
            $ref: '#/components/schemas/svstore.EnumOption'
          title: enum_options
          x-stainless-terraform-configurability: optional
        isKeyField:
          type: boolean
          title: is_key_field
          description: >-
            Whether this field's value drives the entity's key (dedup
            identifier).
             Must be a UNIQUE data type field. At most one per entity type.
          x-stainless-terraform-configurability: computed_optional
        isNameField:
          type: boolean
          title: is_name_field
          description: Whether this field's value drives the entity's display name.
          x-stainless-terraform-configurability: computed_optional
        refEntityTypeId:
          type: string
          title: ref_entity_type_id
          description: >-
            For ENTITY_REF fields: the entity type ID that this field
            references.
          nullable: true
          x-stainless-terraform-configurability: optional
        description:
          type: string
          title: description
          nullable: true
          x-stainless-terraform-configurability: optional
        sourceEntityTypeId:
          type: string
          title: source_entity_type_id
          description: |-
            If set, this field is inherited from the specified entity type.
             Empty means the field is defined directly on this entity type.
          nullable: true
          x-stainless-terraform-configurability: optional
        sectionId:
          type: string
          title: section_id
          description: >-
            Visual grouping for the entity detail UI. Unset means the field
            renders
             in the implicit "Overview" tab.
          nullable: true
          x-stainless-terraform-configurability: optional
      title: EntityTypeField
      additionalProperties: false
    svstore.EntityFieldSection:
      type: object
      properties:
        id:
          type: string
          title: id
          x-stainless-terraform-configurability: optional
        entityTypeId:
          type: string
          title: entity_type_id
          x-stainless-terraform-configurability: optional
        name:
          type: string
          title: name
          x-stainless-terraform-configurability: optional
        sourceEntityTypeId:
          type: string
          title: source_entity_type_id
          description: |-
            If set, this section is mirrored from the specified ancestor type.
             Empty means the section is defined directly on this entity type.
          nullable: true
          x-stainless-terraform-configurability: optional
        createdAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
          x-stainless-terraform-configurability: optional
        updatedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: updated_at
          x-stainless-terraform-configurability: optional
        createdByUserId:
          type: string
          title: created_by_user_id
          x-stainless-terraform-configurability: optional
        updatedByUserId:
          type: string
          title: updated_by_user_id
          x-stainless-terraform-configurability: optional
      title: EntityFieldSection
      additionalProperties: false
      description: >-
        EntityFieldSection is a per-entity-type visual grouping for field
        bindings
         — rendered as tabs on the entity detail UI ("General", "Purchasing",
         "Compliance"). Bindings without a section_id render in an implicit
         "Overview" tab. Sections are materialized down the inheritance chain just
         like fields: when an ancestor defines a section it is mirrored onto every
         descendant with source_entity_type_id pointing back.
    svstore.EntityTypeField.DataType:
      type: string
      title: DataType
      enum:
        - DATA_TYPE_UNSPECIFIED
        - TEXT
        - NUMBER
        - BOOL
        - TIMESTAMP
        - ENUM
        - ENTITY_REF
        - USER_REF
        - UNIQUE
        - MULTI_SELECT
        - FILE
    google.protobuf.Value:
      oneOf:
        - type: 'null'
        - type: number
        - type: string
        - type: boolean
        - type: array
        - type: object
          additionalProperties: true
      description: |-
        `Value` represents a dynamically typed value which can be either
         null, a number, a string, a boolean, a recursive struct value, or a
         list of values. A producer of value is expected to set one of these
         variants. Absence of any variant indicates an error.

         The JSON representation for `Value` is JSON value.
    google.protobuf.Timestamp:
      type: string
      format: date-time
      description: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
    svstore.EnumOption:
      type: object
      properties:
        id:
          type: string
          title: id
          x-stainless-terraform-configurability: optional
        value:
          type: string
          title: value
          x-stainless-terraform-configurability: optional
        displayName:
          type: string
          title: display_name
          x-stainless-terraform-configurability: optional
        displayOrder:
          type: integer
          title: display_order
          format: int32
          x-stainless-terraform-configurability: optional
      title: EnumOption
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````