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

# List custom fields

> List the custom fields of the company (paginated), oldest first. `option` custom fields include their options.

Version:
v4


## OpenAPI

````yaml openapi-v2.json GET /core/v4/custom-fields
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:
    get:
      tags:
        - Custom fields
      summary: List custom fields
      description: >-
        List the custom fields of the company (paginated), oldest first.
        `option` custom fields include their options.
      operationId: ListCustomFields
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 20
            maximum: 300
        - name: section
          in: query
          required: false
          schema:
            type: string
            enum:
              - default
              - labor
              - personal
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - date
              - email
              - geo
              - numeric
              - option
              - phone
              - text
              - url
      responses:
        '200':
          description: The paginated custom fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomFieldsResponse'
        '401':
          description: Missing or invalid API key
        '403':
          description: API consumer lacks permission over the requested resource
        '422':
          description: Validation error
components:
  schemas:
    ListCustomFieldsResponse:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldEntry'
        meta:
          $ref: '#/components/schemas/PaginationMetaEntry'
      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
    PaginationMetaEntry:
      properties:
        currentPage:
          description: Current page number (1-based).
          type: integer
        lastPage:
          description: Last available page number.
          type: integer
        total:
          description: Total number of items across all pages.
          type: integer
        perPage:
          description: Number of items per page.
          type: integer
      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.