API

List Detail Field Library

get
https://api.safetyculture.io/incidents/v1/field-library
Query Params
string

Search on a field's name

string
enum
Defaults to FIELD_CATEGORY_UNSPECIFIED

Search on a field's category

  • FIELD_CATEGORY_UNSPECIFIED: Field category Unspecified.
  • FIELD_CATEGORY_SYSTEM_FIELD: Field category pre-defined.
  • FIELD_CATEGORY_CUSTOM_FIELD: Field category custom.
Allowed:
criteria.filter.field_ids
array of strings

Search on a field's ids

criteria.filter.field_ids
criteria.filter.created_by
array of strings

Filter by creator user IDs

criteria.filter.created_by
criteria.filter.field_types
array of strings

Filter by field value types

  • 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
criteria.filter.field_types
criteria.filter.applies_to
array of strings

Filter by targets that the field applies to

criteria.filter.applies_to
string
enum
Defaults to FIELD_STATE_UNSPECIFIED

Optional. Filter by field state. When not set, defaults to FIELD_STATE_UNSPECIFIED.

  • 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.
Allowed:
string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

string
enum
Defaults to FIELD_OPTION_SORT_UNSPECIFIED

Optional. Defines sorting for field option labels on returned field objects.

  • FIELD_OPTION_SORT_UNSPECIFIED: Unspecified sort order.
  • FIELD_OPTION_SORT_ALPHABETICAL: Alphabetical sort order (default).
  • FIELD_OPTION_SORT_CUSTOM: Custom sort order (as defined by the user).
Allowed:
string
enum
Defaults to SORT_FIELD_UNSPECIFIED

Optional. The field to use for sorting.

  • SORT_FIELD_UNSPECIFIED: SORT_FIELD_UNSPECIFIED returns the default sort order.
  • SORT_FIELD_NAME: SORT_FIELD_NAME sorts fields by name.
  • SORT_FIELD_CREATED_AT: SORT_FIELD_CREATED_AT sorts fields by creation time.
Allowed:
string
enum
Defaults to SORT_DIRECTION_UNSPECIFIED

Optional. The direction to sort fields in.

Allowed:
Responses

Updated about 2 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago