Get all workflows

GET

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

GET

/spaces/:space_id/environments/:environment_id/workflows

$ curl -G https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/workflows \
>      -H "Authorization: Bearer <token>" \
>      --data-urlencode "stepId[in]=ava52mngKshas6,mk2bpsdbJJxNv12aj" \
>      -d sys.entity.sys.linkType=entry \
>      --data-urlencode "sys.entity.sys.id[in]=5KsDBWseXY6QegucYAoacS,A8sDBSseaY6Geg12YAokcZ" \
>      -d sys.workflowDefinition.sys.id=pfjbpijbJJBNv6Jgj \
>      -d order=sys.updatedAt

200Workflows_getAllWorkflows_example

1 {
2   "total": 1,
3   "limit": 100,
4   "skip": 0,
5   "sys": {
6     "type": "Array"
7   },
8   "items": [
9     {
10       "stepId": "someStepId",
11       "sys": {
12         "id": "someWorkflowId",
13         "type": "Workflow",
14         "environment": {
15           "sys": {
16             "id": "staging",
17             "linkType": "Environment",
18             "type": "Link"
19           }
20         },
21         "space": {
22           "sys": {
23             "id": "yadj1kx9rmg0",
24             "linkType": "Space",
25             "type": "Link"
26           }
27         },
28         "workflowDefinition": {
29           "sys": {
30             "linkType": "WorkflowDefinition",
31             "id": "pfjbpijbJJBNv6Jgj",
32             "type": "Link"
33           }
34         },
35         "entity": {
36           "sys": {
37             "linkType": "Entry",
38             "id": "5KsDBWseXY6QegucYAoacS",
39             "type": "Link"
40           }
41         },
42         "version": 1,
43         "createdAt": "2025-05-07T05:15:08.000Z",
44         "createdBy": {
45           "sys": {
46             "linkType": "AppDefinition",
47             "id": "99SummRPRBowauM8T5Ljb34",
48             "type": "Link"
49           }
50         },
51         "updatedAt": "2025-05-07T05:15:08.000Z",
52         "updatedBy": {
53           "sys": {
54             "linkType": "User",
55             "id": "1xGZIRXr2WPnsLkKfREo0z",
56             "type": "Link"
57           }
58         }
59       }
60     },
61     {
62       "stepId": "someStepId",
63       "sys": {
64         "id": "someWorkflowId",
65         "type": "Workflow",
66         "environment": {
67           "sys": {
68             "id": "staging",
69             "linkType": "Environment",
70             "type": "Link"
71           }
72         },
73         "space": {
74           "sys": {
75             "id": "yadj1kx9rmg0",
76             "linkType": "Space",
77             "type": "Link"
78           }
79         },
80         "workflowDefinition": {
81           "sys": {
82             "linkType": "WorkflowDefinition",
83             "id": "pfjbpijbJJBNv6Jgj",
84             "type": "Link"
85           }
86         },
87         "entity": {
88           "sys": {
89             "linkType": "Entry",
90             "id": "5KsDBWseXY6QegucYAoacS",
91             "type": "Link"
92           }
93         },
94         "version": 1,
95         "createdAt": "2025-05-18T12:29:43.000Z",
96         "createdBy": {
97           "sys": {
98             "linkType": "AppDefinition",
99             "id": "99SummRPRBowauM8T5Ljb34",
100             "type": "Link"
101           }
102         },
103         "updatedAt": "2025-05-18T12:29:43.000Z",
104         "updatedBy": {
105           "sys": {
106             "linkType": "User",
107             "id": "1xGZIRXr2WPnsLkKfREo0z",
108             "type": "Link"
109           }
110         }
111       }
112     }
113   ]
114 }

Returns workflows matching the specified query filters. Accessible to all users.

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

stepId[in]stringOptional

Comma-separated list with step IDs. A workflow must be linked to one of those steps.

sys.entity.sys.linkTypestringOptional

This must equal entry if defined. This must be defined together with the next parameter.

sys.entity.sys.id[in]stringOptional

Comma-separated list with entry IDs. A workflow must be linked to one of those entries.

sys.workflowDefinition.sys.idstringOptional

Filter workflows by the ID of the linked workflow definition.

orderstringOptional

Orders the query results by a specified attribute. The prefix - inverts the order (descending). Supported values: sys.updatedAt, -sys.updatedAt, sys.createdAt, -sys.createdAt

skipdoubleOptional

The number of elements to skip before returning matching workflows.

limitdoubleOptional

Limit the number of workflows being returned in the response.

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful