ZOzoominfo
Agents

List Agent Runs

Lists the run history for a specific agent, with the most recent runs returned first. Use this endpoint to review previous and active runs for the agent. To retrieve the current status and results of a specific run, use Get Agent Run instead. This endpoint does not start or modify a run.

get/agent/v1/agents/{agentId}/runs

Request

  • Base URL
    https://api.zoominfo.com/gtm
  • URL
    https://api.zoominfo.com/gtm/agent/v1/agents/{agentId}/runs
  • Auth
    OAuth 2
    Authorization code: https://login.zoominfo.com
    Token URL: https://okta-login.zoominfo.com/oauth2/default/v1/token scopes: api:agent:read

Path parameters

agentIdstring required

The unique identifier of the agent.

Query parameters

filter[status]AgentTaskState[]

Filter runs by one or more task states (comma-delimited).

filter[createdAt]string

Filter runs by creation time: an ISO 8601 timestamp, or the range form [timestamp,*) for on-or-after.

filter[initiatedBy]string

Filter runs by the initiating user, workflow, or API client identifier.

sortstring

Sort order. Only the default -createdAt (newest first) is supported; other values are rejected.

page[size]integer

The number of runs to return per page. Allowable values are between 1 and 100. Defaults to 25.

page[after]string

Opaque cursor from the previous page's links.next. Omit to fetch the first page.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.