Skip to content

Get Workflows

Request

Security
OAuth2(Required scopes: agent-workflows.read)
Query
projectIdstring(Projectid)

The ID of the project

limitinteger(Limit)

Maximum number of workflows to return. Capped at 50.

Default:20
offsetinteger, >= 0(Offset)

Number of workflows to skip.

Default:0
editorstring or null, non-empty(Editor)

Return only workflows whose editors contain this value.

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/agent-workflows?projectId=string&limit=20&offset=0&editor=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
dataArray of objects(Data)required

The page of results.

limitinteger(Limit)required

The limit applied to this page. Equal to the limit query parameter unless it exceeded the maximum allowed value, in which case it is that maximum.

Example:20
offsetinteger(Offset)required

The offset applied to this page (echoes the offset query parameter).

Example:0
totalCountinteger(Totalcount)required

The total number of elements across all pages.

Example:137
Response
{
  "data": [
    { … }
  ],
  "limit": 20,
  "offset": 0,
  "totalCount": 137
}