EXexcalidraw
logs

Get workspace logs

Changed on

Retrieve a paginated list of audit logs for your workspace.

    This endpoint allows you to:
    - Get all audit logs in your workspace
    - Filter logs by user, action, operation, or date range
    - Paginate through large sets of logs using cursor-based or offset-based pagination

    **Use cases:**
    - Building an audit log viewer or dashboard
    - Monitoring workspace activity
    - Compliance and security auditing
    - Tracking user actions and changes

    **Available log actions:**
    - workspace, workspace:team, workspace:invite, workspace:invite:redeem, workspace:preferences, workspace:avatar, workspace:rename, workspace:user, workspace:user:role
    - collection
    - scene, scene:readonly-link, scene:readonly-links, scene:link-sharing, scene:collection, scene:upload, scene:image-upload, scene:slides, scene:comment
    - user:signup
    - ai:diagram-to-code, ai:text-to-diagram, ai:text-to-drawing
get/api/v1/logs

Request

  • Base URL
    https://api.excalidraw.com
  • URL
    https://api.excalidraw.com/api/v1/logs
  • Auth
    HTTP bearer

Query parameters

limitinteger

The number of items to return per page.

offsetinteger

The number of items to skip before starting to collect the result set.

cursorstring

Cursor for pagination (sequence number). Use nextCursor from previous response.

pagestring

Page number for offset-based pagination. Cannot be used with cursor.

userstring

Filter logs by user ID

actionstring

Filter logs by action type

operation'create' | 'read' | 'update' | 'delete'

Filter logs by operation type

dateFromstring

Filter logs from this date (ISO 8601 format)

dateTostring

Filter logs to this date (ISO 8601 format)

Response

This response returns a paginated list of workspace audit logs.

nextCursorunknown required
hasMoreboolean required

Whether there are more logs to fetch

availableActionsstring[] required

List of available log actions that can be filtered

totalCountnumber required

Total count of logs (only when using page parameter)

totalPagesnumber required

Total pages (only when using page parameter)

currentPagenumber required

Current page number (only when using page parameter)

Changes

  • 9fa65a47c84cRevision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      response property logs/items/details/anyOf[subschema #1]/anyOf[subschema #1]/ list-of-types was narrowed by removing types boolean null and number from media type application/json of response 200

    • info

      response property logs/items/ip_address list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property logs/items/source_id list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property logs/items/user_id list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property logs/items/user_picture list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property logs/items/workspace_id list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property nextCursor list-of-types was narrowed by removing types null from media type application/json of response 200