PAparley
Automations

Get an automation

Get one of your automations by ID, with its triggers and instructions.

get/automations/{id}

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/automations/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The automation ID.

Response

OK

idstring required

The automation ID.

namestring required

The automation name.

descriptionstring nullable required

A short summary of what the automation does, or null.

status'active' | 'paused' required

active: the automation runs when its triggers fire. paused: its triggers are on hold, and the automation only runs when someone starts a run.

nextRunAtstring date-time nullable required

When a trigger next starts a run, or null for an automation that is paused or has no scheduled trigger.

createdAtstring date-time required

When the automation was created.

updatedAtstring date-time required

When the automation or its triggers were last changed.

instructionsstring required

The automation's instructions: the prompt Parley's assistant carries out on every run.

Changes

No recorded changes to this operation across all 2 revisions of this API.