Skip to content

Get a workspace workflow activity ​

GET/api/v2/workspaces/{slug}/workflows/{workflow_id}/activities/{pk}/

Retrieve one entry from a catalog workflow's change history.

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.

workflow_id:requiredstring (uuid)

The catalog workflow whose history you want.

pk:requiredstring (uuid)

The id of the activity entry.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

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 ​

workspaces.workflows:read

Errors ​

StatusCodeCause
400invalid_requestAn unknown name in fields.
401unauthorizedMissing or invalid credentials.
402payment_requiredWorkflows isn't on your plan, or is switched off.
403forbiddenYour role or token scope can't view workspace workflows.
404not_foundNo such workflow in this workspace's catalog, or no such entry in its history.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409states_managed_at_projectThe workspace doesn't have governance turned on. Use the project's workflows instead.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Get a workspace workflow activity
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/activities/3a8d1f6c-9e2b-4c57-b4a1-6f0e8d2c9b73/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "id": "3a8d1f6c-9e2b-4c57-b4a1-6f0e8d2c9b73",
  "workflow_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
  "actor_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "state_id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "verb": "added",
  "field": "state_approvers",
  "old_value": "",
  "new_value": "priya",
  "old_identifier": null,
  "new_identifier": "a3f92c71-6e4b-4d08-9b5a-1c7e3d9f2b84",
  "epoch": 1768475092.0,
  "created_at": "2026-01-15T11:04:52.660219Z"
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}