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

# Get custom field

> Retrieve a custom field of the company by id, with its options when its type is `option`.

Version:
v4


## OpenAPI

````yaml openapi-v2.json GET /core/v4/custom-fields/{customFieldId}
openapi: 3.0.0
info:
  title: Sesame Public API v2
  description: >-
    Public API v2 — additive surface `/public/{context}/v{N}`,
    endpoint-versioned from v4
  version: 1.0.0
servers:
  - url: https://api.sesamehr.com
    description: Production
security:
  - Bearer: []
paths:
  /core/v4/custom-fields/{customFieldId}:
    get:
      tags:
        - Custom fields
      summary: Get custom field
      description: >-
        Retrieve a custom field of the company by id, with its options when its
        type is `option`.
      operationId: GetCustomField
      parameters:
        - name: customFieldId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The custom field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldResponse'
        '401':
          description: Missing or invalid API key
        '403':
          description: API consumer lacks permission over the requested resource
        '422':
          description: Validation error
components:
  schemas:
    CustomFieldResponse:
      properties:
        data:
          $ref: '#/components/schemas/CustomFieldEntry'
      type: object
    CustomFieldEntry:
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        slug:
          description: >-
            Read-only identifier generated from the name when the custom field
            is created. It never changes afterwards.
          type: string
        type:
          type: string
          enum:
            - date
            - email
            - geo
            - numeric
            - option
            - phone
            - text
            - url
        section:
          type: string
          enum:
            - default
            - labor
            - personal
        options:
          description: >-
            Options of an `option` custom field, possibly empty. Null for every
            other type.
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldOptionEntry'
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      type: object
    CustomFieldOptionEntry:
      properties:
        id:
          type: string
          format: uuid
        name:
          description: >-
            Option text. It is the value sent for this custom field in `PATCH
            /core/v4/employees/{employeeId}`.
          type: string
      type: object
  securitySchemes:
    Bearer:
      type: http
      description: 'Sesame Public API consumer token (Authorization: Bearer <token>)'
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.