FIfirefly-iii
rules

Get a single rule.

Get a single rule.

get/v1/rules/{id}

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/rules/{id}
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Path parameters

idstring required
Example:123

The ID of the object.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

The requested rule

Example response

{
  "data": {
    "type": "rules",
    "id": "2",
    "attributes": {
      "created_at": "2025-12-01T00:00:00+00:00",
      "updated_at": "2025-12-01T00:00:00+00:00",
      "title": "First rule title.",
      "description": "First rule description",
      "rule_group_id": "81",
      "rule_group_title": "New rule group",
      "order": 5,
      "trigger": "store-journal",
      "active": true,
      "strict": true,
      "triggers": [
        {
          "id": "2",
          "created_at": "2025-12-01T00:00:00+00:00",
          "updated_at": "2025-12-01T00:00:00+00:00",
          "type": "user_action",
          "value": "tag1",
          "order": 5,
          "active": true
        }
      ],
      "actions": [
        {
          "id": "2",
          "created_at": "2025-12-01T00:00:00+00:00",
          "updated_at": "2025-12-01T00:00:00+00:00",
          "type": "set_category",
          "value": "Daily groceries",
          "order": 5,
          "active": true
        }
      ]
    },
    "links": {
      "0": {
        "rel": "self",
        "uri": "/OBJECTS/1"
      },
      "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.