Skip to content

List Fields

Endpoint

http
GET /unified/ticketing/fields
Integrations supported
  • Jira

Query parameters

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
entity_type
string
The entity type the field belongs to
All possible enum values:
  • collection
  • ticket
  • ticket_type
  • user
Enum support by integration
  • Jira
    • ticket_type
Required in
  • Jira
entity_id
string
The unique identifier for the entity the field belongs to
Supported in
  • Jira

Response Body

result
object[]
List of Fields
id
string
The field's unique identifier
Supported in
  • Jira
name
string
The field's name. This is the name of the property in the entity.
Supported in
  • Jira
label
string
The field's label
Supported in
  • Jira
description
string
The field's description
Supported in
  • Jira
type
string
The field's type. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
Supported in
  • Jira
is_hidden
boolean
Whether the field is hidden
is_unique
boolean
Whether the field is unique
is_required
boolean
Whether the field is required
Supported in
  • Jira
options
object[]
The field's options
Supported in
  • Jira
label
string
The option's label
value
string
The option's value
description
string
The option's description
is_hidden
boolean
Whether the option is hidden
is_user_defined
boolean
Whether the field is user defined
entity_type
string
The entity type the field belongs to
All possible enum values:
  • ticket_type
  • ticket
  • collection
  • user
Supported in
  • Jira
entity_id
string
The unique identifier for the entity the field belongs to
Supported in
  • Jira
created_at
string · date-time
The date and time of the field's creation
updated_at
string · date-time
The date and time of the field's last update
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.