List deployment flows

GET /v1/flow

Gets a list of deployment flows in the account. Supports searching, filtering properties and paging.

Source: Robopack public API v1 OpenAPI definition · OpenAPI 3.0.1 · Snapshot: 2026-10-01. Download this snapshot.

Servers

• https://api.robopack.com/

Authentication

Scheme	Type	Location	Name	Description
API key	apiKey	header	X-API-Key	Robopack API key generated for account

Send your API key in the X-API-Key header. Examples read it from ROBOPACK_API_KEY.

Parameters

Name	In	Required	Type	Nullable	Constraints / default	Description
Search	query	No	string	Not declared	—	Text to search flows for.
ShowDeleted	query	No	boolean	Not declared	—	If deleted flows should also be returned.
AppId	query	No	string (uuid)	Not declared	—	Specify an ID of an Instant app to only return flows for that app.
SortBy	query	No	string	Not declared	—	Name of property to sort query by.
SortDesc	query	No	boolean	Not declared	—	If the sort order should be descending.
Page	query	No	integer (int32)	Not declared	—	Index of page of results to return.
DisablePaging	query	No	boolean	Not declared	—	If paging should be disabled and all results returned.
ItemsPerPage	query	No	integer (int32)	Not declared	—	The number of results returned per page. Default: 50, max: 1000.
tenants[]	query	No	array of string (uuid)	Not declared	default: null	Optional list of tenant IDs to filter the returned flows by.

Parameter names and capitalization follow the source definition. Required status follows the parameter's explicit required flag; optional does not imply a server default.

Request body

No request body is declared in the source definition.

Responses

200 response

OK

Response media type: application/json

Type: array of V1FlowViewModel

Only response statuses declared in the snapshot are listed. The source does not define a complete error contract.

curl example

This GET example reads data. Set ROBOPACK_API_KEY in your shell. Query values must be URL encoded. Optional query parameters are omitted.

curl --request GET \
  --url "https://api.robopack.com/v1/flow" \
  --header "X-API-Key: ${ROBOPACK_API_KEY}" \
  --header "Accept: application/json"

Related models

• V1FlowViewModel

Complete operation definition

{
  "description": "Gets a list of deployment flows in the account. Supports searching, filtering properties and paging.",
  "parameters": [
    {
      "description": "Text to search flows for.",
      "in": "query",
      "name": "Search",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "If deleted flows should also be returned.",
      "in": "query",
      "name": "ShowDeleted",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "description": "Specify an ID of an Instant app to only return flows for that app.",
      "in": "query",
      "name": "AppId",
      "schema": {
        "format": "uuid",
        "type": "string"
      }
    },
    {
      "description": "Name of property to sort query by.",
      "in": "query",
      "name": "SortBy",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "If the sort order should be descending.",
      "in": "query",
      "name": "SortDesc",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "description": "Index of page of results to return.",
      "in": "query",
      "name": "Page",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "description": "If paging should be disabled and all results returned.",
      "in": "query",
      "name": "DisablePaging",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "description": "The number of results returned per page. Default: 50, max: 1000.",
      "in": "query",
      "name": "ItemsPerPage",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "description": "Optional list of tenant IDs to filter the returned flows by.",
      "in": "query",
      "name": "tenants[]",
      "schema": {
        "default": null,
        "items": {
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "items": {
              "$ref": "#/components/schemas/V1FlowViewModel"
            },
            "type": "array"
          }
        }
      },
      "description": "OK"
    }
  },
  "summary": "List deployment flows.",
  "tags": [
    "Flow"
  ]
}