Sign in
automations

Get Automation

get/api/v1/automations/{automation_id}

Path parameters

automation_idstring uuid required

Response

Successful Response

idstring uuid required
company_idstring uuid required
namestring required
descriptionstring nullable required
status'draft' | 'active' | 'paused' | 'archived' required

Top-level status of an automation.

created_bystring uuid required
created_atstring required
updated_atstring required
activated_atstring nullable required
is_suppressedboolean required
current_user_level'viewer' | 'editor' | 'admin'

Permission tiers, strictly ordered VIEWER < EDITOR < ADMIN.

is_favoriteboolean

Changes

Changed in 1 of the 13 revisions of this API.3

  • a59877bf911b3See the full diff
    • ●

      added the new custom_code enum value to the nodes/items/kind response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new dataset_sink enum value to the nodes/items/kind response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new load_scenario_revision enum value to the nodes/items/kind response property for the response status 200

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 13 revisions, 1 has no diff computed.