Skip to main content
GET
/
api
/
v1
/
agents
List agents in the caller’s organization
curl --request GET \
  --url https://api.staging.getmodus.com/api/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "agents": [
    {
      "id": 42,
      "slug": "customer-churn-agent-a3f",
      "name": "Customer Churn Analyzer",
      "status": "active",
      "type": "task",
      "orgUuid": "00000000-0000-0000-0000-000000000001",
      "hasUnpublishedChanges": false,
      "isEnabled": true,
      "accessConfig": {
        "visibility": "shared",
        "groupPermissions": {
          "group_eng_uuid": {
            "use": true,
            "manage": false
          }
        },
        "sharedWith": [],
        "ownerUserId": "user_2abc",
        "ownerEmail": "alice@example.com"
      },
      "createdAt": "2026-05-01T10:00:00.000Z",
      "updatedAt": "2026-05-11T10:00:00.000Z",
      "canManage": true,
      "canUse": true,
      "description": "Predicts churn risk for a customer given a 90-day usage window.",
      "activeVariationId": "00000000-0000-4000-a000-000000000100",
      "draftVariationId": "00000000-0000-4000-a000-000000000101",
      "pendingOwnershipTransfer": {
        "pendingOwnerUserId": "user_2abc123def456",
        "requestedByUserId": "user_2xyz789ghi012",
        "requestedAt": "2026-06-05T12:00:00.000Z",
        "pendingOwnerEmail": "newowner@example.com"
      },
      "variation": {
        "trigger": {},
        "workflowStructure": {},
        "agentSelection": {}
      },
      "deletedAt": null
    }
  ],
  "nextPageToken": "eyJsYXN0SWQiOjQyfQ"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageToken
string

Opaque page token from a previous response's nextPageToken. Omit for the first page. AIP-158.

Example:

"eyJsYXN0SWQiOjQyfQ"

​
pageSize
number

Max items per page. Defaults to 25, clamped to 100. AIP-158.

Required range: 1 <= x <= 100
Example:

25

​
view
enum<string>

Variation view. active reads deployed; draft reads the latest builder snapshot.

Available options:
active,
draft
​
type
enum<string>

Filter by agent type.

Available options:
task,
workflow
​
search
string

Case-insensitive substring filter on agent name.

Example:

"sales"

​
includeVariation
boolean

Include the requested variation payload (trigger, workflowStructure, agentSelection) on list rows.

Example:

false

Response

​
agents
object[]
required

Page of agents the caller can at least use. Agents the caller cannot see are filtered out (not enumerated).

​
nextPageToken
string | null
required

Opaque token for the next page; null when this was the last page. Pass as pageToken on the next request. AIP-158.

Example:

"eyJsYXN0SWQiOjQyfQ"