Skip to main content
GET
/
api
/
v1
/
agent
/
all
Get all agents
curl --request GET \
  --url https://dashboard.sequentum.com/api/v1/agent/all \
  --header 'Authorization: Bearer <token>'
[
  {
    "agentTemplates": "<string>",
    "configType": 1,
    "description": "<string>",
    "documentation": "<string>",
    "icon": "<string>",
    "image": "aSDinaTvuI8gbWludGxpZnk=",
    "inputParameters": {},
    "id": 123,
    "isActive": true,
    "lastActivity": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "proxyPoolId": 123,
    "spaceId": 123,
    "startUrl": "<string>",
    "status": 123,
    "userId": 123,
    "validationStatus": 1,
    "version": 123,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.sequentum.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

​
Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Query Parameters

​
pageIndex
integer<int32>

Page number (1-based). If provided with recordsPerPage, enables pagination.

​
recordsPerPage
integer<int32>

Number of records per page. If provided with pageIndex, enables pagination.

​
sortColumn
string
default:name

Column to sort by: name, lastActivity, created, updated, status, configType

​
sortOrder
integer<int32>
default:0

Sort order: 0 = ascending (default), 1 = descending

​
name
string

Filter by agent name (contains match, case-insensitive)

​
status
integer<int32>

Filter by last run status (RunStatus: 0=Invalid, 1=Running, 2=Exporting, 3=Starting, 4=Queuing, 5=Stopping, 6=Failure, 7=Failed, 8=Stopped, 9=Completed, 10=Success, 11=Skipped, 12=Waiting). Agents that never ran have null status.

​
spaceId
integer<int32>

Filter by space ID

​
configType
enum<integer>

Filter by config type

Available options:
1,
2,
3,
4
​
includeArchived
boolean
default:false

Response

Returns the list of agents (array without pagination, object with pagination)

​
agentTemplates
string | null
​
configType
enum<integer>
Available options:
1,
2,
3,
4
​
description
string | null
​
documentation
string | null
​
icon
string | null
​
image
string<byte> | null
​
inputParameters
object
​
id
integer<int32> | null
​
isActive
boolean
read-only
​
lastActivity
string<date-time> | null
​
name
string | null
​
proxyPoolId
integer<int32> | null
​
spaceId
integer<int32> | null
​
startUrl
string | null
​
status
integer<int32> | null
​
userId
integer<int32> | null
​
validationStatus
enum<integer>
Available options:
1,
2,
3
​
version
integer<int32>
​
created
string<date-time>
​
updated
string<date-time>