Automation Rules

GET /v1/automation-rules

GET /v1/automation-rules

Required scopes: automation_rules:read

get/v1/automation-rules

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/automation-rules
  • Auth: HTTP bearer

Query parameters

job_idstring

Job public id; includes inherited pipeline rules. null selects pipeline rules.

department_idstring

Department public id; includes inherited pipeline rules.

pipeline_idstring

Pipeline public id; includes shared rules and all job rules on that pipeline.

triggerstring

Rule trigger.

emailstring

Email type or library template key.

is_activeboolean

Filter rules on or off.

Headers

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Response

Success

object'list' required
has_moreboolean required

Changes

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