---
title: "List Custom Field Definitions"
method: GET
path: "/custom-field-definitions"
tags: ["Custom Field"]
---

# List Custom Field Definitions

`GET /custom-field-definitions`

Retrieves a list of all the custom field definitions.

## Query parameters

- `top` integer
- `skip` integer
- `location` string[]
- `locationStrategy` 'location' | 'lineage' | 'bloodline' | 'genealogy'
- `sort` string
- `fields` string
- `resourceType` 'project' | 'customer' | 'vendor' | 'vendorOrderTemplate'

## Headers

- `Authorization` string, required
- `X-LC-Tenant` string, required

## Response `200`

- ListCustomFieldDefinitionsResponse — A response for the List Custom Field Definitions endpoint.
  - `itemCount` integer, required
  - `items` CustomFieldDefinition[], required
    - `id` string, required — The identifier of the Custom Field Definition, generated by the service.
    - `name` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The display name of the Custom Field.</div>
    - `key` string — The key of the Custom Field, used for querying purposes.
    - `description` string — The description of the Custom Field.
    - `type` 'long' | 'double' | 'boolean' | 'date' | 'string' | 'checkbox' | 'longtext' | 'picklist' | 'multiSelectPicklist', nullable — The value type supported by this Custom Field.
    - `pickListOptions` string[] — Possible values if the type selected is "picklist" or "multiSelectPicklist".
    - `resourceType` 'project' | 'customer' | 'vendor' | 'vendorOrderTemplate' — The resource type to which this Custom Field can be applied.
    - `isReadOnly` boolean, nullable
    - `defaultValue` string — Specifies a default value for this Custom Field. This is required if the "isReadOnly" field is True.
    - `isMandatory` boolean, nullable — Specifies if this Custom Field is mandatory when creating a resource of the supported type.
    - `location` FolderV2 — Folder used for resource storage.
      - `id` string, required — The folder identifier.
      - `name` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The name of the folder.</div>
      - `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
      - `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
        - `id` string, required — The folder identifier.
        - `name` string, required — The name of the folder.
        - `location` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div>The location identifier.
        - `hasParent` boolean, nullable — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div>Indicates if the folder has a parent folder.

## Other responses

- `400` — Error codes: * "invalid": Invalid input in the query parameter mentioned in the "name" field on the error response.
- `401` — The user could not be identified.
- `416` — Error codes: * "requestedRangeNotSatisfiable": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.

---

[API](https://skmtc.net/rws/apis/trados-cloud-platform-api.md) · [All operations](https://skmtc.net/rws/apis/trados-cloud-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rws/trados-cloud-platform-api/revisions/d42dac7c28a3/schema)