Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.workflows.search.json
Raw

priv/docs/methods/admin.workflows.search.json

{
"args": {
"app_id": {
"desc": "The parent app ID for which to return workflows",
"example": "A12345",
"required": false
},
"collaborator_ids": {
"desc": "Only include workflows where all of the provided user IDs are a manager/collaborator of that workflow",
"required": false,
"type": "array"
},
"cursor": {
"desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page",
"example": "dXNlcjpVMDYxTkZUVDI=",
"required": false,
"type": "string"
},
"is_sales_elevate": {
"desc": "Filter workflows by their Sales Elevate status",
"required": false,
"type": "boolean"
},
"limit": {
"default": "20",
"desc": "The number of results that will be returned by the API on each invocation",
"example": "20",
"required": false,
"type": "integer"
},
"no_collaborators": {
"desc": "Only include workflows with no collaborators in the result; default is false",
"required": false,
"type": "boolean"
},
"num_trigger_ids": {
"default": "10",
"desc": "Number of trigger IDs to fetch for each workflow; default is 10",
"required": false,
"type": "integer"
},
"publish_status": {
"default": "published",
"desc": "Filter workflows by their published status",
"required": false,
"type": "string"
},
"query": {
"desc": "A search query to filter for workflow name or description",
"example": "Time off",
"required": false,
"type": "string"
},
"sort": {
"default": "name",
"desc": "The field used to sort the returned workflows",
"required": false,
"type": "string"
},
"sort_dir": {
"default": "desc",
"desc": "Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)",
"required": false,
"type": "string"
},
"source": {
"desc": "Source of workflow creation, either from code or workflow builder _Acceptable values:_ `code` `workflow_builder` `sales_home` `agent`",
"required": false,
"type": "string"
},
"step_function_ids": {
"desc": "Only include workflows that use all of the provided step function ids",
"required": false,
"type": "array"
},
"trigger_type_id": {
"desc": "Only include workflows with this trigger type",
"required": false,
"type": "string"
}
},
"desc": "Search workflows within the team or enterprise",
"errors": {
"invalid_cursor": "Value passed for `cursor` was not valid or is no longer valid.",
"not_allowed": "The user is not allowed to access this API method."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.workflows:read",
"url": "https://docs.slack.dev/reference/scopes/admin.workflows.read"
}
]
}
}