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

# List Custom Fields

> Requires `customFields: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).



## OpenAPI

````yaml /openapi/crm.json get /customFields
openapi: 3.0.3
info:
  title: Universal CRM API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://crm.universal.rollout.com/api
security: []
paths:
  /customFields:
    get:
      tags:
        - Custom Fields
      summary: List Custom Fields
      description: >-
        Requires `customFields: true` in the credential's `entitiesToSync`
        selection and a connector that supports this operation. [Choose what
        data to
        sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout),
        or [fix an entity that is not configured to
        sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).
      operationId: getCustomFields
      parameters:
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - id
        - name: label
          in: query
          required: false
          schema:
            type: string
        - name: rolloutUpdated.gte
          in: query
          required: false
          schema:
            type: string
        - name: rolloutUpdated.lte
          in: query
          required: false
          schema:
            type: string
        - name: next
          in: query
          required: false
          schema:
            type: string
            description: >-
              Cursor of the page to return, from the previous page's
              `_metadata.next`. Can't be combined with `offset`.
        - name: offset
          in: query
          required: false
          schema:
            type: number
            description: >-
              Number of records to skip, for offset paging. Defaults to 0. Can't
              be combined with `next`.
        - name: limit
          in: query
          required: false
          schema:
            default: 10
            description: Records per page, capped at 100.
            type: number
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    type: object
                    properties:
                      collection:
                        type: string
                        enum:
                          - customfields
                        description: The key of this response that holds the records.
                      offset:
                        type: number
                        description: >-
                          Number of records skipped before this page: the
                          `offset` requested, or 0 on a cursor page.
                      limit:
                        type: number
                        description: >-
                          Page size applied: the `limit` requested, capped at
                          100, or 10 by default.
                      total:
                        type: number
                        description: >-
                          Number of records matching the request, across all
                          pages.
                      next:
                        nullable: true
                        description: >-
                          Cursor of the next page, to pass as `next`; null on
                          the last page.
                        type: string
                      nextLink:
                        nullable: true
                        description: >-
                          URL of the next page, this request's with `next` set;
                          null on the last page.
                        type: string
                    required:
                      - collection
                      - offset
                      - limit
                      - total
                      - next
                      - nextLink
                    description: How this page relates to the whole collection.
                  customfields:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - text
                            id:
                              type: string
                            label:
                              type: string
                            name:
                              nullable: true
                              type: string
                            originalIds:
                              type: object
                              additionalProperties:
                                anyOf:
                                  - type: number
                                  - type: string
                            original:
                              type: object
                              additionalProperties:
                                type: object
                                additionalProperties: {}
                          required:
                            - type
                            - id
                            - label
                            - name
                            - originalIds
                            - original
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - date
                            id:
                              type: string
                            label:
                              type: string
                            name:
                              nullable: true
                              type: string
                            isRecurring:
                              type: boolean
                            originalIds:
                              type: object
                              additionalProperties:
                                anyOf:
                                  - type: number
                                  - type: string
                            original:
                              type: object
                              additionalProperties:
                                type: object
                                additionalProperties: {}
                          required:
                            - type
                            - id
                            - label
                            - name
                            - isRecurring
                            - originalIds
                            - original
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - number
                            id:
                              type: string
                            label:
                              type: string
                            name:
                              nullable: true
                              type: string
                            originalIds:
                              type: object
                              additionalProperties:
                                anyOf:
                                  - type: number
                                  - type: string
                            original:
                              type: object
                              additionalProperties:
                                type: object
                                additionalProperties: {}
                          required:
                            - type
                            - id
                            - label
                            - name
                            - originalIds
                            - original
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - dropdown
                            id:
                              type: string
                            label:
                              type: string
                            name:
                              nullable: true
                              type: string
                            choices:
                              type: array
                              items:
                                type: string
                            originalIds:
                              type: object
                              additionalProperties:
                                anyOf:
                                  - type: number
                                  - type: string
                            original:
                              type: object
                              additionalProperties:
                                type: object
                                additionalProperties: {}
                          required:
                            - type
                            - id
                            - label
                            - name
                            - choices
                            - originalIds
                            - original
                    description: The records of this page, under the collection's name.
                required:
                  - _metadata
                  - customfields
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
        '409':
          description: Response for status 409
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                    enum:
                      - >-
                        Data for this credential is not ready yet. Please try
                        again.
                required:
                  - errorMessage
      security:
        - jwt: []
          credential_id: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend
    credential_id:
      type: apiKey
      in: header
      name: X-Rollout-Credential-Id
      description: The Rollout Credential ID to use for queries/mutations

````

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