Aller au contenu

Get activity logs for envelopes and team

Ce contenu n’est pas encore disponible dans votre langue.

You can list team activity logs (e.g. API key created, member joined) and envelope activity logs (e.g. envelope created, document signed) with the same endpoint. Use it for audit trails or syncing activity to your system.

Your team API key must have the right permission for the category you request:

CategoryRequired permission
teamRead Team
envelopeRead Envelope

When creating or editing the key in Subnoto (Settings → API keys), enable the matching permission. A key with only Read Team can list team logs; it cannot list envelope logs.

Endpoint: POST /public/logs/list

Body:

  • category: "team" or "envelope" (required)
  • For envelope: optional workspaceUuid, envelopeUuid
  • Optional: eventTypes, page, limit, sortBy, sortOrder

Example (team logs, first page):

{
"category": "team",
"page": 1,
"limit": 50
}

Example (envelope logs for one envelope):

{
"category": "envelope",
"envelopeUuid": "your-envelope-uuid",
"page": 1,
"limit": 50
}

Response: { "logs": [ ... ], "totalCount": number }. Each log has category, eventType, eventData, timestamp, author, and for envelope logs envelopeUuid and workspaceUuid.

Pass eventTypes in the request body to filter by one or more events. Use only events for the category you request (envelope events with category: "envelope", team events with category: "team").

Event typeDescription
ENVELOPE_CREATEDEnvelope was created
ENVELOPE_SENTEnvelope was sent to recipients
DOCUMENT_SIGNEDA document was signed
ENVELOPE_COMPLETEDEnvelope was completed
ENVELOPE_OPENEDEnvelope was opened
ENVELOPE_DECLINEDEnvelope was declined
ENVELOPE_CANCELEDEnvelope was canceled
RECIPIENT_VERIFIEDRecipient was verified
Event typeDescription
TEAM_CREATEDTeam was created
TEAM_CONFIG_UPDATEDTeam configuration changed
MEMBER_INVITEDMember was invited
INVITE_REVOKEDInvite was revoked
MEMBER_JOINEDMember joined the team
MEMBER_REMOVEDMember was removed
MEMBER_ROLE_UPDATEDMember role was updated
API_KEY_CREATEDAPI key was created
API_KEY_UPDATEDAPI key was updated
API_KEY_INVALIDATEDAPI key was invalidated
WEBHOOK_CREATEDWebhook was created
WEBHOOK_UPDATEDWebhook was updated
WEBHOOK_DELETEDWebhook was deleted
SSO_CONFIG_CREATEDSSO config was created
SSO_CONFIG_UPDATEDSSO config was updated
SSO_CONFIG_DELETEDSSO config was deleted

For the full request and response schema, see the Public API OpenAPI spec.

Terminal window
curl -X POST https://enclave.subnoto.com/public/logs/list \
-H "Authorization: Bearer YOUR_ACCESS_KEY:YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"category":"team","page":1,"limit":50}'

If you use the Encryption Proxy, replace the host with your proxy URL and use the same path and body.