Automation Rules

GET /v1/automation-rules/{rule_id}

GET /v1/automation-rules/{rule_id}

Required scopes: automation_rules:read

get/v1/automation-rules/{rule_id}

Request

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

Path parameters

rule_idstring required

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

pipeline_template_idstring nullable required
job_idstring nullable required
needs_step_pickboolean required
namestring required
starter_keystring nullable required
job_scope'all_compatible' | 'selected' required
job_posting_idsstring[] required
delivery_mode'auto_send' | 'auto_draft_review' required
pipeline_stage_idstring nullable required
trigger'stage_enter' | 'stage_exit' | 'step_ready' | 'booking_created' | 'booking_changed' | 'step_completed' | 'feedback_submitted' | 'all_scorecards_submitted' | 'interview_time' | 'booking_cancelled' | 'scorecard_due' | 'scorecard_overdue' | 'decision_brief_ready' | 'coaching_report_ready' | 'offer_approval_due' | 'offer_approval_escalation_due' required
is_activeboolean required
positioninteger nullable required
idstring required
object'automation_rule' required
created_atstring nullable required
updated_atstring nullable required

Changes

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