List Rules | propelone | Documentation

curl -G https://https//https/opportunities/automation/rules \
     -H "{{tenant_key_name}}: X-Tenant-Key" \
     -H "Content-Type: application/json" \
     -d "filter[entity_type]=opportunity" \
     -d "filter[trigger_type]=OPPORTUNITY_STAGE_CHANGED" \
     -d "filter[is_active]=true" \
     -d "filter[tenant_location_id]=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
     -d page=1 \
     -d per_page=15

{
  "rules": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Notify Sales on Stage Change",
      "entity_type": "opportunity",
      "trigger_type": "OPPORTUNITY_STAGE_CHANGED",
      "is_active": true,
      "created_at": "2024-05-10T09:15:00Z",
      "actions": [
        {
          "type": "send_email",
          "parameters": {
            "recipient": "sales-team@company.com",
            "subject": "Opportunity Stage Changed",
            "body": "The opportunity stage has been updated."
          }
        }
      ]
    },
    {
      "id": "b2c3d4e5-f678-9012-abcd-ef2345678901",
      "name": "Close Opportunity on Win",
      "entity_type": "opportunity",
      "trigger_type": "OPPORTUNITY_WON",
      "is_active": true,
      "created_at": "2024-04-22T14:45:00Z",
      "actions": [
        {
          "type": "update_status",
          "parameters": {
            "status": "closed_won"
          }
        }
      ]
    }
  ],
  "page": 1,
  "per_page": 15,
  "total": 2
}

List automation rules scoped to opportunities.

Query parameters

filter[entity_type]stringOptional

Optional: Filter by entity type - lead|opportunity

filter[trigger_type]stringOptional

Optional: Valid TriggerType enum value - e.g. OPPORTUNITY_STAGE_CHANGED, OPPORTUNITY_WON, OPPORTUNITY_LOST

filter[is_active]stringOptional

Optional: Boolean - filter by active flag - true|false

filter[tenant_location_id]stringOptional

Optional: UUID converted by middleware - leave blank to inherit from pb-ectlid header

pageintegerOptional

Optional: Page number - default 1

per_pageintegerOptional

Optional: Results per page - default 15, max 100

Response

Successful response

Headers

Query parameters

Response