List document activity

GET/v1/documents/{id}/activity

Returns the timeline of a document: created, sent, viewed, payments, reminders, void and credit notes.

Each entry records what happened and who did it: a member, an API key, an MCP token, the AI agent, a store connector, the client or the system. Use it to answer "did the client open the invoice?" or "who voided this?".

Permission: documents.view
Type: Read-only. Changes nothing.
Auth: API key, MCP token or signed-in session
Capability: list_document_activity
CLI: freeinvoiceautomation doc activity
Available: At launch, 1 January 2027

list_document_activity

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/documents/<id>/activity \
  --header 'Authorization: Bearer <api-key>'

{
  "data": [
    {
      "id": "0193f2ba-1a2b-7c3d-8e4f-5a6b7c8d9e01",
      "event": "viewed",
      "actor_type": "client",
      "actor_id": null,
      "data": null,
      "created_at": "2027-02-02T07:41:00Z"
    },
    {
      "id": "0193f2ba-1a2b-7c3d-8e4f-5a6b7c8d9e00",
      "event": "sent",
      "actor_type": "user",
      "actor_id": "0193f29d-0f1e-7d2c-8b3a-49586a7b8c9d",
      "data": {
        "channel": "email"
      },
      "created_at": "2027-02-01T10:15:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Authorizations

Authorizationstringrequired

Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.

Path Parameters

idstring<uuid>required

Id of the document.

Query Parameters

limitintegerdefault:50

Page size, 1 to 200.

cursorstring

Cursor from the previous page's next_cursor.

Response

200 - application/json

dataobject[]

The activity entries on this page.

next_cursorstring | null

Cursor for the next page, or null on the last page.

has_moreboolean

Whether another page exists.

Suggest edits Raise issue

List document versionsPrevious List overdue invoicesNext

list_document_activity

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/documents/<id>/activity \
  --header 'Authorization: Bearer <api-key>'

{
  "data": [
    {
      "id": "0193f2ba-1a2b-7c3d-8e4f-5a6b7c8d9e01",
      "event": "viewed",
      "actor_type": "client",
      "actor_id": null,
      "data": null,
      "created_at": "2027-02-02T07:41:00Z"
    },
    {
      "id": "0193f2ba-1a2b-7c3d-8e4f-5a6b7c8d9e00",
      "event": "sent",
      "actor_type": "user",
      "actor_id": "0193f29d-0f1e-7d2c-8b3a-49586a7b8c9d",
      "data": {
        "channel": "email"
      },
      "created_at": "2027-02-01T10:15:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}