v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-174421106.5 KB
PlaybookRuns

Get property fields for a playbook run

get/plugins/playbooks/api/v0/runs/{id}/property_fields

Path parameters

idstring required
Example:mx3xyzdojfgyfdx8sc8of1gdme

ID of the playbook run to retrieve property fields from.

Query parameters

updated_sinceinteger
Example:1602235338837

Filter results to only include property fields updated after this timestamp (Unix time in milliseconds).

Response

List of property fields for the playbook run.

idstring

A unique, 26 characters long, alphanumeric identifier for the property field.

type'text' | 'select' | 'multiselect'

The type of the property field.

namestring

The name of the property field.

descriptionstring

The description of the property field.

create_atinteger

The property field creation timestamp, formatted as the number of milliseconds since the Unix epoch.

update_atinteger

The property field update timestamp, formatted as the number of milliseconds since the Unix epoch.

delete_atinteger

The property field deletion timestamp, formatted as the number of milliseconds since the Unix epoch. It equals 0 if not deleted.

attrsobject

Additional attributes for the property field (options for select fields, visibility, etc.).

Example response

[
  {
    "id": "p7fj3k2l5m8n9q1r4s6t8v0w2x",
    "type": "select",
    "name": "Priority",
    "description": "Issue priority level",
    "create_at": 1602235338837,
    "update_at": 1602235338837,
    "attrs": {
      "visibility": "when_set",
      "sortOrder": 1,
      "options": [
        {
          "id": "opt1",
          "name": "High",
          "color": "#ff0000"
        }
      ]
    }
  }
]