Book a demo

List Fields

jira.list_fields
ActionBusiness appsconnection required

Calls the Jira Cloud REST API with the connection's email and API token.

List Jira's field definitions, which is how a custom field id is resolved.

Ask about JiraAll Jira nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
Username & password
Providers
Jira
Secret shape
{"email", "api_token"}
Config it needs
domain
Resolved by
config.connection_id, else node.connection_id

Configuration

2 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
query
Filter to fields whose name or id contains this text, e.g. 'sprint'.
stringNo———
custom_only
Return only custom fields, leaving out Jira's built-in ones.
booleanNofalse——

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "custom_only": false
}

Output

One shape.

result

FieldTypeExample
fields[].id
The field id used in the API.
stringcustomfield_10011
fields[].key
The field's key.
string—
fields[].name
The label shown in Jira, e.g. 'Sprint'.
string—
fields[].custom
True for a custom field.
boolean—
fields[].schema.type
The value type the field holds.
string—
count
How many items this call returned.
number—
{
  "count": 0,
  "fields": [
    {
      "custom": false,
      "id": "customfield_10011",
      "key": "",
      "name": "",
      "schema": {
        "type": ""
      }
    }
  ]
}

Notes

  • Custom fields are keyed by id, not label: 'customfield_10011'. Run jira.list_fields once to map a field's name to its id.
  • Jira has no server-side filter here, so query and custom_only are applied to the full list after it is fetched.

Related Jira nodes

Templates that use Jira

Solutions with Jira

See List Fields run in a workflow.

In a technical demo we add the Jira connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales