List custom fields for cases

  • Published on Aug 6, 2025
  • 1 minute(s) read
Prev Next
Get
/v1alpha/cases/custom_fields

Returns the custom fields applicable to the specified cases.

Security
HTTP
Type bearer
Query parameters
filter.case_ids
array of integer

The IDs of the cases to retrieve custom fields for.

filter.keys
array of string

The keys of the custom fields to retrieve.

Responses
200

A successful response.

Expand All
object
custom_fields
Array of object (custom_fieldsv1CustomField)

The custom fields for the specified cases.

object
key
string

The key of the custom field.

Examplefoo
case_id
integer (int32)

The ID of the case to which the custom field applies.

Example123
value
string

The value of the custom field.

Examplebar
schema
object (v1CustomFieldSchema)
type
string

The custom field type enum.

  • TYPE_UNSPECIFIED: The custom field value type is unspecified.
  • TYPE_SHORT_TEXT: The custom field value type is text.
  • TYPE_NUMBER: The custom field value type is number.
  • TYPE_BOOLEAN: The custom field value type is boolean.
  • TYPE_TIMESTAMP: The custom field value type is timestamp.
  • TYPE_LIST_SINGLE_SELECT: The custom field value type is list single select.
Valid values[ "TYPE_UNSPECIFIED", "TYPE_SHORT_TEXT", "TYPE_NUMBER", "TYPE_BOOLEAN", "TYPE_TIMESTAMP", "TYPE_LIST_SINGLE_SELECT" ]
Default"TYPE_UNSPECIFIED"
short_text
object (CustomFieldSchemaShortTextConstraints)

The constraints applied to the custom field value if the type is TYPE_SHORT_TEXT.

min_length
integer (int32)

The minimum length of the custom field value.

Example1
max_length
integer (int32)

The maximum length of the custom field value.

Example255
regex
string

The regular expression that the custom field value must match.

Example^foo$
single_select
object (CustomFieldSchemaSingleSelectConstraints)

The constraints applied to the custom field value if the type is TYPE_LIST_SINGLE_SELECT.

allowed_values
Array of string

The list of acceptable values for the custom field.

Example[ "foo", "bar" ]
string
401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object