Getting a list of workflows

Use this request to get a list of all workflows in the organization.

GET

https://api.tracker.yandex.net/v3/workflows

Request format

Before making the request, get API access.

To get a list of workflows, use an HTTP request with the GET method.

GET /v3/workflows
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

Headers

Host: address of the node that provides the API.
Authorization: Authorization token about these formats:
- OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more
- Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Identity Hub organization is linked to Tracker. Learn more
X-Org-ID or X-Cloud-Org-ID: Organization ID.
- Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.
- Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Identity Hub.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Response format

Request executed successfully

Request failed

If the request is successful, the API returns a response with code 200 OK.

The response body contains an array of workflows in JSON format. All organization workflows except deleted ones are returned.

The API does not return optional fields that have no value, such as queue, type, createdBy, and updatedBy.

[
    {
        "self": "https://api.tracker.yandex.net/v3/workflows/W21",
        "id": "W21",
        "name": "Design",
        "version": 1,
        "steps": [
            {
                "status": {
                    "self": "https://api.tracker.yandex.net/v3/statuses/1",
                    "id": "1",
                    "key": "open",
                    "display": "Open"
                },
                "actions": [
                    {
                        "id": "inProgress",
                        "name": "Start progress",
                        "target": {
                            "self": "https://api.tracker.yandex.net/v3/statuses/3",
                            "id": "3",
                            "key": "inProgress",
                            "display": "In progress"
                        }
                    }
                ]
            },
            {
                "status": {
                    "self": "https://api.tracker.yandex.net/v3/statuses/3",
                    "id": "3",
                    "key": "inProgress",
                    "display": "In progress"
                },
                "actions": [
                    {
                        "id": "close",
                        "name": "Close",
                        "target": {
                            "self": "https://api.tracker.yandex.net/v3/statuses/8",
                            "id": "8",
                            "key": "closed",
                            "display": "Closed"
                        }
                    }
                ]
            },
            {
                "status": {
                    "self": "https://api.tracker.yandex.net/v3/statuses/8",
                    "id": "8",
                    "key": "closed",
                    "display": "Closed"
                }
            }
        ],
        "initialAction": {
            "id": "open",
            "name": "Open",
            "target": {
                "self": "https://api.tracker.yandex.net/v3/statuses/1",
                "id": "1",
                "key": "open",
                "display": "Open"
            }
        },
        "queue": {
            "self": "https://api.tracker.yandex.net/v3/queues/DESIGN",
            "id": "4",
            "key": "DESIGN",
            "display": "DESIGN"
        },
        "created": "2026-08-11T14:37:06.356+0000",
        "updated": "2026-08-11T14:37:06.356+0000",
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "User Name",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 1100000000
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "User Name",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 1100000000
        },
        "deleted": false,
        "type": "visual"
    }
]

Response parameters

Parameter	Description	Data type
self	Workflow link.	String
id	Workflow ID.	String
name	Workflow name.	String
version	Workflow version. Each change increases the version number.	Number
steps	Array of workflow steps.	Array of objects
initialAction	Initial action.	Object
queue	Queue the workflow is linked to.	Object
created	Creation date and time.	String
updated	Date and time of the last update.	String
createdBy	Workflow author.	Object
updatedBy	User who last updated the workflow.	Object
deleted	Indicates whether the workflow has been deleted.	Boolean
type	Workflow type. The only current value is `visual`. The field may be missing for workflows created earlier.	String

Fields of the steps array objects

Parameter	Description	Data type
status	Step status.	Object
actions	Array of actions (transitions) available from this status.	Array of objects

Fields of the status object

Parameter	Description	Data type
self	Status link.	String
id	Status ID.	String
key	Status key.	String
display	Status display name.	String

Fields of the action and initialAction objects

Parameter	Description	Data type
id	Action ID.	String
name	Action name.	String
target	Target status that the action transitions to.	Object

Fields of the target object

Parameter	Description	Data type
self	Status link.	String
id	Status ID.	String
key	Status key.	String
display	Status display name.	String

Fields of the queue object

Parameter	Description	Data type
self	Queue link.	String
id	Queue ID.	String
key	Queue key.	String
display	Queue display name.	String

Fields of the user object (createdBy, updatedBy)

Parameter	Description	Data type
self	User link.	String
id	User ID.	String
display	User display name.	String
cloudUid	Unique user ID in Yandex Cloud.	String
passportUid	Unique user account ID in Yandex Passport.	Number

If the request is not processed successfully, the API returns an error response:

401: The user is not authorized. Make sure that actions described in the API access section are performed.

403: You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.

Was the article helpful?

Create a workflow

Get a workflow