---
title: "Get a List of Custom Fields"
method: GET
path: "/custom-fields"
tags: ["Custom Fields"]
---

# Get a List of Custom Fields

`GET /custom-fields`

Retrieve a list of the custom fields you've set up in your SysAid account.

## Query parameters

- `limit` integer
- `offset` integer
- `entityType` CustomColumnEntityType[]
- `fieldName` string

## Response `200`

A list of custom fields.

- PaginatedCustomFieldInfoList
  - `limit` integer — The number of items that are returned per page
  - `offset` integer — The offset used for pagination.
  - `total` integer — The total number of elements across all pages.
  - `data` CustomFieldInfo[]
    - `fieldName` string, required — The technical identifier of the custom field, used internally by the system and stored at the database level, for example, sr_cust_addon_jira_projectkey. This value can also be used for service record filtering.
    - `fieldCaption` string, required — Custom field name.
    - `fieldType` 'date' | 'dateTime' | 'float' | 'integer' | 'list' | 'multiSelectList' | 'relationalList' | 'relationalMultiSelectList' | 'text' | 'textArea', required — Defines the custom field type.
    - `entityType` 'sr' | 'ci' | 'asset' | 'user' | 'task' | 'project' | 'company' | 'actionItem', required — SysAid entities for which custom fields can be created.
    - `values` object — The indexed options available in custom fields of type List or Multi-Select List.

## Other responses

- `400` — The request was invalid or cannot be served
- `401` — Authentication information is missing or invalid

---

[API](https://skmtc.net/sysaid/apis/sysaid-public-api.md) · [All operations](https://skmtc.net/sysaid/apis/sysaid-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sysaid/sysaid-public-api/revisions/38a43a1b2981/schema)