Get all workflow changelog records

GET

https://api.contentful.com/spaces/:space_id/environments/:environment_id/workflows_changelog

GET

/spaces/:space_id/environments/:environment_id/workflows_changelog

$ curl -G https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/workflows_changelog \
>      -H "Authorization: Bearer <token>" \
>      -d entity.sys.linkType=entry \
>      -d entity.sys.id=5KsDBWseXY6QegucYAoacS \
>      -d workflow.sys.id=fh6dsmnLKsh468

200Workflows Changelog_getAllWorkflowChangelogRecords_example

1 {
2   "total": 2,
3   "limit": 100,
4   "skip": 0,
5   "sys": {
6     "type": "Array"
7   },
8   "items": [
9     {
10       "workflow": {
11         "sys": {
12           "linkType": "Workflow",
13           "id": "fh6dsmnLKsh468",
14           "type": "Link"
15         }
16       },
17       "eventBy": {
18         "sys": {
19           "linkType": "",
20           "id": "id",
21           "type": "Link"
22         }
23       },
24       "stepName": "stepName",
25       "workflowDefinition": {
26         "sys": {
27           "linkType": "pfjbpijbJJBNv6Jgj",
28           "id": "id",
29           "type": "Link"
30         }
31       },
32       "stepId": "stepId",
33       "eventAt": "eventAt",
34       "stepAnnotations": [
35         "cf-color-1",
36         "some-custom-annotation"
37       ],
38       "event": "completed",
39       "entity": {
40         "sys": {
41           "linkType": "<entity_type>",
42           "id": "<entity_id>",
43           "type": "Link"
44         }
45       }
46     },
47     {
48       "workflow": {
49         "sys": {
50           "linkType": "Workflow",
51           "id": "fh6dsmnLKsh468",
52           "type": "Link"
53         }
54       },
55       "eventBy": {
56         "sys": {
57           "linkType": "",
58           "id": "id",
59           "type": "Link"
60         }
61       },
62       "stepName": "stepName",
63       "workflowDefinition": {
64         "sys": {
65           "linkType": "pfjbpijbJJBNv6Jgj",
66           "id": "id",
67           "type": "Link"
68         }
69       },
70       "stepId": "stepId",
71       "eventAt": "eventAt",
72       "stepAnnotations": [
73         "cf-color-1",
74         "some-custom-annotation"
75       ],
76       "event": "completed",
77       "entity": {
78         "sys": {
79           "linkType": "<entity_type>",
80           "id": "<entity_id>",
81           "type": "Link"
82         }
83       }
84     }
85   ]
86 }

Returns workflow changelog records matching the specified filters, sorted by event date descending. Accessible to any user with read access to the specified entry.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

space_idstringRequired

ID of the space in form of a string

environment_idstringRequired

ID of the environment in form of a string

Query parameters

entity.sys.linkTypestringRequired

This must equal "entry"

entity.sys.idstringRequired

ID of the entry for which the workflow was executed

workflow.sys.idstringOptional

ID of the associated workflow

eventAt[lte]stringOptional

Filter records based on their occurrence before or on the specified ISO 8601 date

eventAt[gte]stringOptional

Filter records based on their occurrence after or on the specified ISO 8601 date

workflowDefinition.sys.id[in]stringOptional

Comma-separated list of workflow definition IDs used to filter records

skipdoubleOptional

The number of elements to skip before returning matching changelog records

limitdoubleOptional

Limit the number of changelog records being returned in the response

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful