Skip to content

List workflow activities ​

GET/api/v2/workspaces/{slug}/projects/{project_id}/workflows/{workflow_id}/activities/

Return the audit trail of one project workflow as a paginated list, oldest entry first. Each entry records who changed the workflow, what changed, and the old and new values.

Pass ?created_at__gt= with the created_at of the newest entry you hold to read only the entries added since your last poll.

Plane writes entries in the background after each change, so an entry can appear a moment after the write that caused it.

In a governed workspace, workflows live in the workspace catalog and this route returns 404 for them. Use Workspace workflow activities there.

Path parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring

The project the workflow belongs to. Accepts the project UUID or its bare identifier, for example ENG.

workflow_id:requiredstring (uuid)

The workflow whose audit trail you want. An id that is not a workflow of this project returns 404.

Query parameters ​

Filters combine with AND.

created_at__gt:optionalstring (date-time)

Return only entries recorded strictly after this ISO 8601 timestamp, for example 2026-01-14T09:22:41.478363Z. Use it for incremental polling: pass the created_at of the newest entry from your previous read.

verb:optionalstring

Return only entries with this exact verb, for example added or updated. Plane doesn't validate the verb, so an unknown verb returns an empty list.

field:optionalstring

Return only entries about this part of the workflow, for example transition_rule or workflow_state. Plane doesn't validate the value.

actor_id:optionalstring (uuid)

Return only entries made by this user.

Ordering ​

order_by:optionalstring

Field to sort by. Prefix with - for descending.

  • created_at, -created_at. The default is created_at, oldest first.
  • id, -id

Pagination ​

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Use the next value from the response instead of computing offsets yourself.

paginate:optionalstring

Set to cursor to switch to the keyset envelope, which skips the COUNT query and returns next_cursor and has_more instead of next and total_count. Leave it out to get the default offset envelope.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then omitted from the response.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return on each row. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: actor_id, created_at, epoch, field, id, new_identifier, new_value, old_identifier, old_value, state_id, verb, workflow_id.

See Sparse fields.

Scopes ​

projects.workflows:read

Errors ​

StatusCodeCause
400invalid_requestA ?fields= name, per_page, offset, or a filter failed validation.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe Workflows feature isn't on your plan, or is turned off.
403forbiddenYour role or token scope can't read this project's workflows.
404not_foundNo such workspace, project, or workflow in this project, including a catalog workflow in a governed workspace.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List workflow activities
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/9e3f6a2c-7b14-4d8e-a5c1-2f60b8d4e719/activities/?created_at__gt=2026-01-14T09:00:00Z" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "a41d7c93-5e28-4b06-9f17-3c8e2b6d0a54",
      "workflow_id": "9e3f6a2c-7b14-4d8e-a5c1-2f60b8d4e719",
      "actor_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "state_id": "2c4d16f8-9b3e-4a52-8d71-1f0e6c9a5b48",
      "verb": "added",
      "field": "transition_rule",
      "old_value": null,
      "new_value": "send_webhook",
      "old_identifier": null,
      "new_identifier": "3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69",
      "epoch": 1768382561.0,
      "created_at": "2026-01-14T09:22:41.478363Z"
    },
    {
      "id": "c0e58b27-91d4-4a3f-8e62-7b19d4f3a085",
      "workflow_id": "9e3f6a2c-7b14-4d8e-a5c1-2f60b8d4e719",
      "actor_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "state_id": "2c4d16f8-9b3e-4a52-8d71-1f0e6c9a5b48",
      "verb": "updated",
      "field": "transition_rule",
      "old_value": null,
      "new_value": "send_webhook",
      "old_identifier": "3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69",
      "new_identifier": "3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69",
      "epoch": 1768382810.0,
      "created_at": "2026-01-14T09:26:50.107219Z"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}
Response200
json
{
  "data": [
    {
      "id": "a41d7c93-5e28-4b06-9f17-3c8e2b6d0a54",
      "workflow_id": "9e3f6a2c-7b14-4d8e-a5c1-2f60b8d4e719",
      "actor_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "state_id": "2c4d16f8-9b3e-4a52-8d71-1f0e6c9a5b48",
      "verb": "added",
      "field": "transition_rule",
      "old_value": null,
      "new_value": "send_webhook",
      "old_identifier": null,
      "new_identifier": "3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69",
      "epoch": 1768382561.0,
      "created_at": "2026-01-14T09:22:41.478363Z"
    }
  ],
  "next_cursor": "b3A9MTcx",
  "has_more": true,
  "pagination": {
    "style": "cursor"
  }
}

Store the newest created_at

After each poll, keep the largest created_at you received and send it as created_at__gt next time. With the default oldest-first order, each poll returns only new entries, in the order they happened.