> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atollhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read outbound settings, safe destinations and delivery history

> Existing human management rules or an explicit heartbeat.manage_self/heartbeat.manage_others grant. Other excludes self. Real enabled agent identities only; integrations/setup keys are excluded. Resource visibility is the current caller/target intersection. Project destinations separately require webhook.dispatch and both principals project access; organization destinations require webhook.organization_manage. Private/no-store responses. PUT is full replacement, preview persists nothing, test queues an empty labeled payload under the actual tester. Authority is rechecked before queue/retry; in-flight requests cannot be recalled.



## OpenAPI

````yaml /openapi.json get /api/orgs/{id}/agents/{agentId}/outbound-heartbeat
openapi: 3.1.0
info:
  title: Atoll API
  version: 1.0.0
  description: >-
    REST API for Atoll project management, agent collaboration, strategy
    tracking, and integrations.
servers:
  - url: https://atollhq.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Organizations
  - name: Projects
  - name: Project access
  - name: Issues
  - name: Issue details
  - name: Milestones
  - name: Artifacts
  - name: Strategy
  - name: Members and agents
  - name: Planning
  - name: Setup
  - name: Integrations and billing
  - name: Notifications and public
  - name: Private inbox
  - name: Agent executions
  - name: Human attention
  - name: Products
paths:
  /api/orgs/{id}/agents/{agentId}/outbound-heartbeat:
    get:
      tags:
        - Agents
      summary: Read outbound settings, safe destinations and delivery history
      description: >-
        Existing human management rules or an explicit
        heartbeat.manage_self/heartbeat.manage_others grant. Other excludes
        self. Real enabled agent identities only; integrations/setup keys are
        excluded. Resource visibility is the current caller/target intersection.
        Project destinations separately require webhook.dispatch and both
        principals project access; organization destinations require
        webhook.organization_manage. Private/no-store responses. PUT is full
        replacement, preview persists nothing, test queues an empty labeled
        payload under the actual tester. Authority is rechecked before
        queue/retry; in-flight requests cannot be recalled.
      operationId: get_agent_outbound_heartbeat
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Outbound management or decision response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            Heartbeat target not found (missing, foreign and unauthorized are
            indistinguishable)
        '409':
          description: >-
            Current lifecycle, archive, hidden saved selection or permission
            conflict; reload before retry
      security:
        - humanSessionAuth: []
        - bearerAuth: []
components:
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Authenticated but not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      description: >-
        Common error responses contain error. Shared missing-auth and
        unknown-API responses also contain a stable code.
      properties:
        error:
          type: string
        code:
          type: string
      required:
        - error
      examples:
        - error: Unauthorized
          code: unauthorized
        - error: Not found
          code: not_found
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_atoll_<key>
    humanSessionAuth:
      type: apiKey
      in: cookie
      name: sb-<project-ref>-auth-token
      description: >-
        Authenticated Supabase web session for a human Atoll user. The cookie
        name includes the deployment's Supabase project reference and may be
        chunked.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.