Get a Trail
Return one Trail definition. The response includes the current trigger, active action bindings, lifecycle state, and occurrence times. The operation does not return run history.
/trails/{trail_id}Return one Trail definition. The response includes the current trigger, active action bindings, lifecycle state, and occurrence times. The operation does not return run history.
In: cookie
Path Parameters
A unique identifier for this resource.
Response Body
application/json
application/json
curl -X GET "https://example.com/trails/cc5lnd2s1s4652adtu50"{
"id": "cc5lnd2s1s4652adtu50",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"misc": {},
"name": "string",
"description": "string",
"created_by": {
"id": "cc5lnd2s1s4652adtu50",
"joined": "2019-08-24T14:15:22Z",
"suspended": "2019-08-24T14:15:22Z",
"handle": "Southclaws",
"name": "Barnaby Keene",
"signature": "<body><p>Sent with love from London!</p></body>",
"roles": [
{
"badge": true,
"default": true,
"id": "cc5lnd2s1s4652adtu50",
"name": "string",
"colour": "string",
"meta": {}
}
]
},
"status": "active",
"trigger": {
"type": "schedule",
"schedule": {
"start": "2026-08-18T10:00:00",
"timezone": "string",
"rule": {
"frequency": "hourly",
"interval": 1,
"by_weekday": [
"monday"
],
"by_month": [
1
],
"by_month_day": [
-31
],
"count": 1
}
}
},
"actions": [
{
"id": "cc5lnd2s1s4652adtu50",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"misc": {},
"action": {
"type": "robot_run",
"robot_ref": "string",
"instruction": "string"
}
}
],
"next_occurrence_at": "2019-08-24T14:15:22Z",
"last_occurrence_at": "2019-08-24T14:15:22Z"
}{
"type": "string",
"title": "string",
"detail": "string",
"trace_id": "string",
"metadata": {}
}Create a Trail POST
Create a Trail with one trigger and one or more action bindings. The server records the requesting account as the creator and validates the trigger, actions, and lifecycle state. An active Trail receives its next occurrence when the trigger has a future occurrence.
List Trails GET
Return all Trail definitions that the requesting account can manage. Each item includes its trigger, action bindings, lifecycle state, and latest occurrence times. Archived Trails remain in the result.