---
title: "List Detail Field Library"
method: GET
path: "/incidents/v1/field-library"
tags: ["Investigations"]
---

# List Detail Field Library

`GET /incidents/v1/field-library`

## Query parameters

- `criteria.filter.search` string
- `criteria.filter.category` 'FIELD_CATEGORY_UNSPECIFIED' | 'FIELD_CATEGORY_SYSTEM_FIELD' | 'FIELD_CATEGORY_CUSTOM_FIELD'
- `criteria.filter.field_ids` string[]
- `criteria.filter.created_by` string[]
- `criteria.filter.field_types` string[]
- `criteria.filter.applies_to` string[]
- `criteria.filter.state` 'FIELD_STATE_UNSPECIFIED' | 'FIELD_STATE_ACTIVE' | 'FIELD_STATE_DELETED' | 'FIELD_STATE_ARCHIVED'
- `criteria.filter.mapping_metadata[string]` string
- `criteria.option_sort` 'FIELD_OPTION_SORT_UNSPECIFIED' | 'FIELD_OPTION_SORT_ALPHABETICAL' | 'FIELD_OPTION_SORT_CUSTOM'
- `criteria.sort_field` 'SORT_FIELD_UNSPECIFIED' | 'SORT_FIELD_NAME' | 'SORT_FIELD_CREATED_AT'
- `criteria.sort_direction` 'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'

## Response `200`

A successful response.

- S12IncidentsV1ListDetailFieldLibraryResponse
  - `fields` S12TypefieldV1Field[] — the detail fields
    - `id` string — A global unique identifier for a field.
    - `name` string — Name of the field.
    - `description` string — Description of the field.
    - `field_category` 'FIELD_CATEGORY_UNSPECIFIED' | 'FIELD_CATEGORY_SYSTEM_FIELD' | 'FIELD_CATEGORY_CUSTOM_FIELD' — - FIELD_CATEGORY_UNSPECIFIED: Field category Unspecified. - FIELD_CATEGORY_SYSTEM_FIELD: Field category pre-defined. - FIELD_CATEGORY_CUSTOM_FIELD: Field category custom.
    - `value_type` 'FIELD_VALUE_TYPE_UNSPECIFIED' | 'FIELD_VALUE_TYPE_STRING' | 'FIELD_VALUE_TYPE_MONEY' | 'FIELD_VALUE_TYPE_TIMESTAMP' | 'FIELD_VALUE_TYPE_USER_ID' | 'FIELD_VALUE_TYPE_SELECT' | 'FIELD_VALUE_TYPE_TEMPLATE_ID' | 'FIELD_VALUE_TYPE_MULTI_SELECT' | 'FIELD_VALUE_TYPE_SITE' | 'FIELD_VALUE_TYPE_MULTI_SITE' | 'FIELD_VALUE_TYPE_INTEGER' | 'FIELD_VALUE_TYPE_ADDRESS' | 'FIELD_VALUE_TYPE_TIMEZONE' | 'FIELD_VALUE_TYPE_CONTACT_DETAILS' — Type of FieldValue. Defaults to type String. - FIELD_VALUE_TYPE_UNSPECIFIED: Field value type unspecified. - FIELD_VALUE_TYPE_STRING: Field value type string. - FIELD_VALUE_TYPE_MONEY: Field value type money. - FIELD_VALUE_TYPE_TIMESTAMP: Field value type timestamp. - FIELD_VALUE_TYPE_USER_ID: Field value type user ID. - FIELD_VALUE_TYPE_SELECT: Field value type select - FIELD_VALUE_TYPE_TEMPLATE_ID: Field value type template ID. - FIELD_VALUE_TYPE_MULTI_SELECT: Field value type multi-select - FIELD_VALUE_TYPE_SITE: Field value type site - FIELD_VALUE_TYPE_MULTI_SITE: Field value type multi-site - FIELD_VALUE_TYPE_INTEGER: Field value type integer - FIELD_VALUE_TYPE_ADDRESS: Field value type address. - FIELD_VALUE_TYPE_TIMEZONE: Field value type timezone - FIELD_VALUE_TYPE_CONTACT_DETAILS: Field value type contact details
    - `domain` 'DOMAIN_UNSPECIFIED' | 'DOMAIN_GLOBAL' | 'DOMAIN_ASSETS' | 'DOMAIN_CONTRACTORS' | 'DOMAIN_LICENSES_AND_CREDENTIALS' | 'DOMAIN_TASKS' | 'DOMAIN_USERS' | 'DOMAIN_INVESTIGATIONS' | 'DOMAIN_STRUCTURES' | 'DOMAIN_INTEGRATIONS_HRIS_STAGING' — The domain is used to specify which domain the data is coming from. This allows the shared generic type field service to keep track of which domain owns the data, and enforce any domain-specific access control rules. - DOMAIN_UNSPECIFIED: Domain Unspecified. - DOMAIN_GLOBAL: Owned and managed by system can be used by multiple domains - DOMAIN_ASSETS: Owned and created from Assets domain - DOMAIN_CONTRACTORS: Owned and created from Contractor Management domain - DOMAIN_LICENSES_AND_CREDENTIALS: Owned and created from the Licenses and Credentials domain - DOMAIN_TASKS: Owned and created from the Tasks domain - DOMAIN_USERS: Owned and created from the Users domain - DOMAIN_INVESTIGATIONS: Owned and created from the Investigations domain - DOMAIN_STRUCTURES: Owned and created from the Organisational Structures domain - DOMAIN_INTEGRATIONS_HRIS_STAGING: Owned and created from the Integrations domain
    - `field_state` 'FIELD_STATE_UNSPECIFIED' | 'FIELD_STATE_ACTIVE' | 'FIELD_STATE_DELETED' | 'FIELD_STATE_ARCHIVED' — State of the field. - FIELD_STATE_UNSPECIFIED: Field state unspecified. - FIELD_STATE_ACTIVE: Field is active. - FIELD_STATE_DELETED: Field is deleted. - FIELD_STATE_ARCHIVED: Field is archived and no longer active, but not deleted. Cannot be applied to system fields.
    - `select_options` S12TypefieldV1FieldOption[] — The options of a field select.
      - `id` string — The id of a field select option.
      - `label` string — The label of a field select option.
      - `order` integer — The display order of this option, 0-indexed. Options should be displayed in ascending order of this field, matching the order they were defined in the field settings.
    - `created_by` string — CreatorID belonging to the field
  - `next_page_token` string — the token for the next page of results

## Other responses

- `default` — An unexpected error response.

---

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