Agents

Endpoints for managing AI agents — automated organization members with configurable behavior, permissions, and Slack integration.

Attributes

agent_config agent config
Response

The agent's configuration, containing its AI instructions and Slack trigger settings.

avatar_url string
Response Request

URL of the agent's avatar image.

created_at string
Response Parameter `filter` Parameter `sort`

The timestamp when this agent was created.

Response

The custom role assigned to this agent, defining its permissions within the organization.

custom_role_id integer
Request Parameter `filter`

The ID of the custom role assigned to this agent, which defines its permissions.

deactivated_at string
Response Parameter `filter`

The timestamp when this agent was deactivated. null if the agent is currently active.

id integer
Parameter `filter`

The unique identifier of the agent.

manager person
Response

The human team member responsible for managing this agent — cannot be another agent.

manager_id integer
Request Parameter `filter`

The ID of the person responsible for managing this agent.

name string
Response Request Parameter `filter` Parameter `sort`

The agent's display name, derived from its first name.

person person
Response

The underlying Person record backing this agent.

query string
Parameter `filter`

Free-text search filter for agents — matches against the agent's name.

status string
Response Enum

The agent's current status — active when available, deactivated when disabled.

Enum Values (2 values)

  • active
    Active
  • deactivated
    Deactivated
status_id integer
Parameter `filter` Enum

The numeric identifier for the agent's status — integer alternative to the string status field, used for filtering.

Enum Values (2 values)

  • 1
    Active
  • 2
    Deactivated
title string
Response Request Parameter `filter` Parameter `sort`

The agent's job title or functional role label.

updated_at string
Response Parameter `sort`

The timestamp when this agent was last updated.