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

# Get the activity feed

> `?kind=` is exact. `?domain=` matches the leading segment of `kind`, so `?domain=api` is every write made through this API. `?actor=` takes a user id, or the literal `system` for rows with no person behind them — which is where your keys' own writes appear.



## OpenAPI

````yaml /openapi.json get /api/v1/activity
openapi: 3.1.0
info:
  title: Ergoly platform API
  version: 1.0.0
  description: >-
    Read and change one organization's own Ergoly environment. Every route is
    scoped to the organization the presented credential resolves to; there is no
    parameter that widens it. The human-readable reference is served from the
    same namespace at `/api/v1/docs`, behind the same credential.


    The namespace's front door is `GET /api/v1`, and it is deliberately absent
    from `paths` below. It answers without a credential — what this API is, how
    an organization admin mints a key, and where the reference lives — so it is
    the way in to this contract rather than a part of it: it has no scope, takes
    no parameters, and there is nothing about it for a generated client to call.
    Every `unauthorized` refusal carries that same URL as `error.docs`.
servers:
  - url: https://control.ergoly.ai
security:
  - orgApiKey: []
tags:
  - name: auth
    description: How to present a key, what it is scoped to, and what a 401 means.
  - name: organization
    description: Which organization your credential resolves to.
  - name: workers
    description: The Slack apps and bot identities in your organization.
  - name: eworks
    description: The runtime instances under a Worker — one core, one per bound Client.
  - name: clients
    description: The customers a Worker can be scoped to, and how to bind one.
  - name: channels
    description: Which Slack rooms a Worker answers in, and who it answers as.
  - name: tasks
    description: >-
      Tasks handed between Workers and people, scheduled jobs, their targets,
      and their run history.
  - name: jobs
    description: How a provisioning run is going — the other half of every 202.
  - name: memory
    description: Read and write the memory tiers an ework mounts.
  - name: connections
    description: The credentials your agents use, and the hosts they are injected on.
  - name: webhooks
    description: Inbound URLs an outside system can POST to, each of which starts a turn.
  - name: activity
    description: Your organization's audit feed.
  - name: usage
    description: Cost, turn outcomes and a per-day pulse over a window you choose.
  - name: errors
    description: The closed set of refusal codes, and what to do about each.
paths:
  /api/v1/activity:
    get:
      tags:
        - activity
      summary: Get the activity feed
      description: >-
        `?kind=` is exact. `?domain=` matches the leading segment of `kind`, so
        `?domain=api` is every write made through this API. `?actor=` takes a
        user id, or the literal `system` for rows with no person behind them —
        which is where your keys' own writes appear.
      operationId: listActivity
      parameters:
        - name: kind
          in: query
          required: false
          description: Exact match on the dotted event name.
          schema:
            type: string
            description: Exact match on the dotted event name.
        - name: domain
          in: query
          required: false
          description: >-
            Matches the leading segment of `kind` — `api`, `worker`, `foreman`,
            `sandbox`.
          schema:
            type: string
            description: >-
              Matches the leading segment of `kind` — `api`, `worker`,
              `foreman`, `sandbox`.
        - name: actor
          in: query
          required: false
          description: A user id, or the literal `system` for actor-less rows.
          schema:
            type: string
            description: A user id, or the literal `system` for actor-less rows.
        - name: limit
          in: query
          required: false
          description: >-
            Page size. Defaults to 50, clamped at 200. A value that is not a
            positive integer is a 400.
          schema:
            type: integer
            description: >-
              Page size. Defaults to 50, clamped at 200. A value that is not a
              positive integer is a 400.
        - name: cursor
          in: query
          required: false
          description: >-
            Opaque keyset cursor from the previous page's `page.nextCursor`. A
            cursor this API did not issue is a 400, never a silent page one.
          schema:
            type: string
            description: >-
              Opaque keyset cursor from the previous page's `page.nextCursor`. A
              cursor this API did not issue is a 400, never a silent page one.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ActivityEntry'
                    description: The page.
                  page:
                    $ref: '#/components/schemas/PageInfo'
                required:
                  - data
                  - page
                additionalProperties: false
              example:
                data:
                  - id: b0a91827-3645-4c5d-8e7f-90a1b2c3d4e5
                    kind: api.worker.created
                    domain: api
                    actorClerkUserId: null
                    payload:
                      worker_id: 8f1c2d3e-9a4b-4c5d-8e6f-1a2b3c4d5e6f
                      slug: rowan
                      actor_kind: api_key
                      actor_api_key_id: ak_2b9f1c
                    createdAt: '2026-02-11T14:03:22.000Z'
                page:
                  limit: 50
                  hasMore: true
                  nextCursor: >-
                    MjAyNi0wMy0wNFQwOToxNDowMi4wMDBafDhmMWMyZDNlLTlhNGItNGM1ZC04ZTZmLTFhMmIzYzRkNWU2Zg
        '400':
          description: '`invalid_request`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`rate_limited`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - orgApiKey:
            - activity:read
components:
  schemas:
    ActivityEntry:
      type: object
      description: One audit row from your organization's feed.
      properties:
        id:
          type: string
          description: The row id.
        kind:
          type: string
          description: Dotted event name, e.g. `api.worker.created`.
        domain:
          type: string
          description: Leading segment of `kind` — `api`, `worker`, `foreman`, `sandbox`.
        actorClerkUserId:
          type:
            - string
            - 'null'
          description: >-
            The user who caused it, or null for a system actor. No display name
            is resolved: the id is what a machine caller correlates on.
        payload:
          type: object
          description: Event-specific fields. Shape varies by `kind`.
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
          description: When it happened.
      required:
        - id
        - kind
        - domain
        - actorClerkUserId
        - payload
        - createdAt
      additionalProperties: false
    PageInfo:
      type: object
      description: Present on every list, even when there is nothing more to fetch.
      properties:
        limit:
          type: integer
          description: The page size actually applied, after clamping.
        hasMore:
          type: boolean
          description: True when another page exists.
        nextCursor:
          type:
            - string
            - 'null'
          description: >-
            Feed back as `?cursor=`. Null when `hasMore` is false — and always
            null on a list that takes no `cursor` parameter, which ranks its
            rows rather than paging them and says so on its own page. Narrow
            that list's `query` instead.
      required:
        - limit
        - hasMore
        - nextCursor
      additionalProperties: false
    Error:
      type: object
      description: The one error shape. Every refusal in this namespace has it.
      properties:
        error:
          type: object
          description: The refusal.
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - not_found
                - invalid_request
                - conflict
                - quota_exceeded
                - rate_limited
                - upstream_error
                - gone
              description: The machine-stable half. Branch on this, never on `message`.
            message:
              type: string
              description: Prose for a human reading a terminal.
            docs:
              type: string
              description: >-
                Where to learn how to authenticate. Present on `unauthorized`
                and on nothing else — it is the one refusal a caller can reach
                with no credential at all, so it is the one that has to say
                where the way in is.
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    orgApiKey:
      type: http
      scheme: bearer
      description: >-
        An organization-scoped API key, minted in control under Settings → API
        keys. Every failure to authenticate answers one identical 401: "Provide
        a valid organization-scoped API key or an active session." Each
        operation names the one scope it is filed under,
        `<resource>:<read|write>`, where the resource is the first path segment
        after `/api/v1/`; a key minted today carries all 22 of them. Scopes are
        RECORDED — on the key and on every audit row — and are not yet enforced:
        no request is refused for want of one.

````

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