List all workflows

Beta

GET

List all workflows in the organization

Query parameters

sortstringOptional

Field to sort by

directionstringOptional

Sort in ascending or descending order

start_atstringOptional

created_at to start at

limitintegerOptional

Limit of records to return

querystringOptional

Search query

Response

Successful Response

datalist of objects

has_moreboolean

next_cursordatetimeOptional

GET

1 curl https://api-prod.scoutos.com/v2/workflows \
2      -H "Authorization: Bearer <apiKey>"

200Retrieved

1 {
2   "data": [
3     {
4       "workflow_config": {},
5       "last_updated_at": "2024-01-15T09:30:00Z",
6       "created_at": "2024-01-15T09:30:00Z",
7       "created_by": {
8         "type": "user",
9         "details": {
10           "user_id": "user_id",
11           "org_id": "org_id",
12           "scout_organization_id": "scout_organization_id",
13           "email": {
14             "key": "value"
15           }
16         }
17       },
18       "last_updated_by": {
19         "type": "user",
20         "details": {
21           "user_id": "user_id",
22           "org_id": "org_id",
23           "scout_organization_id": "scout_organization_id",
24           "email": {
25             "key": "value"
26           }
27         }
28       },
29       "revision_id": "revision_id",
30       "workflow_id": "workflow_id",
31       "is_draft": true
32     }
33   ],
34   "has_more": true,
35   "next_cursor": "2024-01-15T09:30:00Z"
36 }

Built with

1	curl https://api-prod.scoutos.com/v2/workflows \
2	-H "Authorization: Bearer <apiKey>"

1	{
2	"data": [
3	{
4	"workflow_config": {},
5	"last_updated_at": "2024-01-15T09:30:00Z",
6	"created_at": "2024-01-15T09:30:00Z",
7	"created_by": {
8	"type": "user",
9	"details": {
10	"user_id": "user_id",
11	"org_id": "org_id",
12	"scout_organization_id": "scout_organization_id",
13	"email": {
14	"key": "value"
15	}
16	}
17	},
18	"last_updated_by": {
19	"type": "user",
20	"details": {
21	"user_id": "user_id",
22	"org_id": "org_id",
23	"scout_organization_id": "scout_organization_id",
24	"email": {
25	"key": "value"
26	}
27	}
28	},
29	"revision_id": "revision_id",
30	"workflow_id": "workflow_id",
31	"is_draft": true
32	}
33	],
34	"has_more": true,
35	"next_cursor": "2024-01-15T09:30:00Z"
36	}