Skip to main content
GET
/
api
/
v2
/
agents
/
list
List Agents
curl --request GET \
  --url https://app.octavehq.com/api/v2/agents/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "hasNext": false,
  "total": 0,
  "data": [
    {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "type": "PROSPECTOR",
      "costToRun": 123,
      "steps": 123,
      "itemType": "agent",
      "contentOutputFormat": "JSON"
    }
  ]
}

Authorizations

​
api_key
string
header
required

Query Parameters

​
type
enum<string>

Type of the agent to list

Available options:
PROSPECTOR,
CONTENT,
EMAIL,
ENRICH_PERSON,
ENRICH_COMPANY,
QUALIFY_PERSON,
QUALIFY_COMPANY,
CALL_PREP
​
query
string
default:""

Query for which agents to list

​
offset
number | null
default:0

Offset of the agent to list

​
limit
number | null
default:10

Limit of the agent to list

​
orderField
enum<string>
default:createdAt

Field to order the agents by

Available options:
createdAt,
updatedAt
​
orderDirection
enum<string>
default:DESC

Direction to order the agents by

Available options:
ASC,
DESC
​
includeExperiments
boolean | null
default:false

Whether to include experiments in the results. Only applies to EMAIL and CONTENT agent types. NOTE: when set to true, the response will be a list of agents and experiments so the total will be the sum of the agents and experiments and you may receive more items than the limit.

Response

List agents successful

​
_metadata
object
required
​
hasNext
boolean
required

Whether there are more results

Example:

false

​
total
number
required

Total number of results

Example:

0

​
data
object[]
required
  • Option 1
  • Option 2
⌘I