Skip to main content

​
Overview

This endpoint allows users to retrieve the list of workflows. It supports filtering by workflow ID, status, creator, or creation date. Authentication via an authorization token is required.

  • Method: GET
  • URL: /v0/workflows/
  • Operation: Retrieve all workflows
  • Authentication Required: Yes

​
Authorization

You need the api key which you can get from the API tab in Workspace Settings. The api key is required in almost all the commands

Authorization: <YOUR_API_KEY>

​
Path Parameters

The project_id path parameter uniquely identifies the project whose associated workflows are to be listed. This ensures that only wokflows relevant to the specified project are retrieved, maintaining clear scoping within the system.

FieldTypeRequiredDescription
project_idstringYesUnique identifier for the project containing the workflows

​
Query Parameters

Query parameters allow you to narrow the wokflow list based on specific needs. You can filter by **workflow ID, creator’s user ID, or creation date. These filters help users efficiently find relevant workflows within a project.

FieldTypeRequiredDescription
idstringNoFilter the results by a specific workflow ID
namestringNoFilter the results by display workflow name
created_bystringNoFilter workflows by the user who created them
created_onstringNoFilter workflows by the date they were created (ISO 8601 format)
updated_atstringNoFilter workflows by the date they were updated (ISO 8601 format)

​
Response

A 200 OK response contains an array of wokflow objects matching the provided criteria. Each object includes metadata like wokflow ID, name , creator, and creation timestamp. The array may be empty if no workflows match the filter conditions or if none exist under the specified project.

NameTypeDescription
idstringUnique identifier of the workflow
project_idstringUnique identifier for the project containing the workflow
namestringFilter the results by display workflow name
created_bystringUser ID of the person who created the workflow
created_atstringTimestamp when the workflow was created (ISO 8601 format)
updated_atstringTimestamp when the workflow was last updated (ISO 8601 format)
Here is a sample 200 response:
200
 {
  "workflows": [
    {
      "id": "<string>",
      "project_id": "<string>",
      "name": "<string>",
      "created_by": "<string>",
      "description": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}
A 400 Bad Request occurs when query parameters are malformed or invalid. A 403 Forbidden response indicates that the user does not have permission to access workflows under the specified project. Error responses include structured fields like code, message, and optional troubleshooting details.
400 403
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

​
How to use the endpoint

  1. Construct your Request:
    Ensure you have the project_id and a valid bearer token. Optionally include query parameters for filtering workflows.
  2. Send the Request:
    Make a GET request to https://api.pixxel.space/v0/workflows. Include your Authorization header.
  3. Examine the Response:
    On success, you’ll receive an array of workflows matching the criteria. Handle errors based on status codes and messages in the response.