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

# List custom field definitions

> Returns custom field definitions for the account. Without `project_id`, only account-wide definitions are returned; pass `project_id` to also include definitions scoped to that project.



## OpenAPI

````yaml GET /custom_field_definitions
openapi: 3.1.0
info:
  title: Mangrove - API
  version: 1.1.0
servers:
  - url: https://app.gomangrove.com/api/v1
security:
  - sec0: []
paths:
  /custom_field_definitions:
    get:
      summary: List custom field definitions
      description: >-
        Returns custom field definitions for the account. Without `project_id`,
        only account-wide definitions are returned; pass `project_id` to also
        include definitions scoped to that project.
      operationId: list-custom-field-definitions
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            format: int32
            default: 1
        - name: page_size
          in: query
          schema:
            type: integer
            format: int32
            default: 20
        - name: object_type
          in: query
          description: Filter by the record type the definitions apply to
          schema:
            type: string
            enum:
              - project
              - asset
        - name: project_id
          in: query
          description: >-
            Project friendly ID (e.g., prj_abc123). Widens the result to include
            that project's scoped definitions.
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    data:
                      - id: 42
                        friendly_id: cfd_abc123def456
                        key: serial
                        label: Serial Number
                        object_type: asset
                        value_type: string
                        enumeration_options: null
                        order: 1
                        is_required: false
                        project_id: null
                        created_at: '2026-01-15T10:00:00.000Z'
                        updated_at: '2026-01-15T10:00:00.000Z'
                    info:
                      items: 1
                      page_size: 20
                      total_items: 1
                      current_page: 1
                      next_page: null
                      previous_page: null
                      total_pages: 1
                      sort: []
                      filter: []
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        friendly_id:
                          type: string
                          description: >-
                            Custom field definition friendly ID (e.g.,
                            cfd_abc123def456)
                        key:
                          type: string
                          description: >-
                            Stable identifier used as the key in
                            custom_field_values maps
                        label:
                          type: string
                        object_type:
                          type: string
                          enum:
                            - project
                            - asset
                        value_type:
                          type: string
                          enum:
                            - string
                            - number
                            - boolean
                            - date
                            - enum
                            - url
                        enumeration_options:
                          type: array
                          items:
                            type: string
                          nullable: true
                        order:
                          type: integer
                        is_required:
                          type: boolean
                        project_id:
                          type: string
                          nullable: true
                          description: >-
                            Project friendly ID when the definition is
                            project-scoped; null when account-wide
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                  info:
                    type: object
                    properties:
                      items:
                        type: integer
                      page_size:
                        type: integer
                      total_items:
                        type: integer
                      current_page:
                        type: integer
                      next_page:
                        type: integer
                        nullable: true
                      previous_page:
                        type: integer
                        nullable: true
                      total_pages:
                        type: integer
        '422':
          description: '422'
          content:
            application/json:
              examples:
                Result:
                  value:
                    status: error
                    statusCode: 422
                    errors:
                      - message: 'Unknown object_type. Valid values: project, asset'
      deprecated: false
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: ''

````