Get an automation edge
GET/api/v2/workspaces/{slug}/automations/{automation_id}/edges/{pk}/
Workspace automations are rule graphs that run across a workspace. Read a single automation edge by id.
Path Parameters
slug:requiredstringThe workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.
automation_id:requiredstring (uuid)The automation the resource belongs to.
pk:requiredstring (uuid)The automation edge id.
Response shaping
fields:optionalstringComma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.
Requestable here: created_at, created_by_id, execution_order, id, source_node_id, target_node_id, updated_at, version_id.
Scopes
automations:read
Errors
| Status | Code | Cause |
|---|---|---|
401 | unauthorized | Missing or invalid credentials. |
402 | payment_required | The feature this endpoint belongs to isn't enabled on your plan or is switched off. |
403 | forbidden | Your role or token scope doesn't allow this. |
404 | not_found | No such resource, or it's outside your tenant. |
406 | not_acceptable | The Accept header asks for a representation the API can't produce. |
429 | rate_limited | Throttled. Honor the Retry-After header before retrying. |
Get an automation edge
bash
curl -X GET \
"https://api.plane.so/api/v2/workspaces/my-team/automations/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/edges/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/" \
-H "X-Api-Key: $PLANE_API_KEY"python
import requests
response = requests.get(
"https://api.plane.so/api/v2/workspaces/my-team/automations/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/edges/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/",
headers={"X-Api-Key": "your-api-key"},
)
print(response.json())javascript
const response = await fetch(
"https://api.plane.so/api/v2/workspaces/my-team/automations/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/edges/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/",
{
method: "GET",
headers: {
"X-Api-Key": "your-api-key",
},
},
);
const data = await response.json();Response200
json
{
"created_at": "2026-01-14T09:22:41.478363Z",
"created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
"execution_order": 1,
"id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
"source_node_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
"target_node_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
"updated_at": "2026-01-14T09:22:41.478363Z",
"version_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}Response404
json
{
"type": "not_found",
"code": "not_found",
"detail": "No automation edge matches the given query."
}
