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

# Lists the custom fields defined for clients.

> Every active client custom field, in the order a client's CustomProperties lists them: its id
(what a CustomProperties entry on PATCH /v1/clients/{clientId} takes), type, whether it is
required, its default and, for a Dropdown, the options a value must be one of. Not paginated.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/clients/custom-fields
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/clients/custom-fields:
    get:
      tags:
        - Clients
      summary: Lists the custom fields defined for clients.
      description: "Every active client custom field, in the order a client's CustomProperties lists them: its id\r\n(what a CustomProperties entry on PATCH /v1/clients/{clientId} takes), type, whether it is\r\nrequired, its default and, for a Dropdown, the options a value must be one of. Not paginated."
      operationId: get_v1_clients_custom-fields
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ClientCustomFieldModelListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ClientCustomFieldModelListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ClientCustomFieldModelListBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    ClientCustomFieldModelListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/ClientCustomFieldModel'
          nullable: true
        DataContext:
          type: object
          additionalProperties: false
          nullable: true
          example: null
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    ClientCustomFieldModel:
      type: object
      properties:
        Id:
          type: integer
          description: Custom field identifier - the `Id` of a `CustomProperties` entry.
          format: int64
        Variable:
          type: string
          description: The field's variable name, returned raw with no prefix.
        Name:
          type: string
          description: Custom field display name.
        Type:
          $ref: '#/components/schemas/CodeModel'
        Description:
          type: string
          description: Description shown with the field in Gorelo.
          nullable: true
        IsRequired:
          type: boolean
          description: >-
            Whether every client must hold a value; a PATCH that would leave it
            with none is refused.
        DefaultValue:
          type: string
          description: "The value a client without its own value shows. Always null when `IsHidden` is true, since\r\na default can be the secret itself."
          nullable: true
        Options:
          type: array
          items:
            type: string
          description: >-
            For a Dropdown field, the options a value must be one of, exactly as
            written; otherwise null.
          nullable: true
        IsHidden:
          type: boolean
          description: "True when your organization has hidden this field's value from the API in Gorelo: values are then\r\nreturned as null, though they can still be written."
        CreatedOn:
          type: string
          description: Creation timestamp (UTC).
          format: date-time
          nullable: true
        UpdatedOn:
          type: string
          description: Last-updated timestamp (UTC).
          format: date-time
          nullable: true
      additionalProperties: false
      description: "A custom field defined for clients, as listed by `GET /v1/clients/custom-fields`: what a\r\n`CustomProperties` entry on `PATCH /v1/clients/{clientId}` may carry. Timestamps are UTC."
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
    CodeModel:
      type: object
      properties:
        Id:
          type: integer
          description: >-
            Numeric identifier of the coded value (e.g. status, priority, type,
            or source id).
          format: int64
          example: 1
        Name:
          type: string
          description: Display name of the coded value.
      additionalProperties: false
      description: >-
        A coded value, such as a status, priority, type or source, as an id and
        a display name.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

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