Documents

List document activities

Changed on

List the activities recorded for a document, newest first (sort=id for oldest first). Paged: 20 per page by default; the X-Pagination-Total-Count, X-Pagination-Page-Count, X-Pagination-Current-Page and X-Pagination-Per-Page headers describe the full list, and a page past the end returns an empty data. Each entry carries an event-specific payload snapshot (keys vary per event) and the request origin (ip, user-agent).

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/documents/{documentId}/activities

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/documents/{documentId}/activities
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

documentIdstring required

Document ID.

Query parameters

sortstring

-id (default, newest first) or id.

pageinteger
Example:1

Page number.

per-pageinteger
Example:25

Records per page (max 100).

Response

Document activities

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": [
    {
      "id": 4,
      "event": "assignment_created",
      "message": "Assignment created by John Smith.",
      "origin": {
        "ip": "172.19.0.1"
      },
      "created_at": "2022-07-19T19:28:13Z"
    }
  ]
}

Changes

  • dda5f0d393cbRevision changes
    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per-page

    • info

      added the new optional query request parameter sort