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

# List workspace activities

> Returns all activity log entries for a workspace.



## OpenAPI

````yaml /api-reference/openapi.json get /workspaces/{workspaceSlug}/activities/
openapi: 3.1.0
info:
  title: Nvisy API
  summary: Document processing and annotation platform
  description: >-
    Nvisy provides intelligent document processing, annotation, and analysis
    capabilities. This API enables document upload, OCR processing, embedding
    generation, and semantic search across your document collections.
  termsOfService: https://nvisy.com/legal/terms-of-service
  contact:
    name: Nvisy Support
    url: https://nvisy.com
    email: hello@nvisy.com
  license:
    name: Proprietary
    url: https://nvisy.com/license
  version: 0.1.0
servers: []
security: []
tags:
  - name: Accounts
    description: Account management and profile operations
  - name: Authentication
    description: Login, signup, and token management
  - name: Workspaces
    description: Workspace creation and management
  - name: Files
    description: File upload, download, and management
  - name: Members
    description: Workspace member management
  - name: Invites
    description: Workspace invitation handling
  - name: API Tokens
    description: API token management
  - name: Connections
    description: External provider connections
  - name: Pipelines
    description: Redaction pipeline configuration
  - name: Pipeline Runs
    description: Pipeline run execution and review
  - name: Policies
    description: Redaction policy configuration
  - name: Webhooks
    description: Webhook configuration
  - name: Notifications
    description: Account notification management
  - name: Health
    description: Service health checks
paths:
  /workspaces/{workspaceSlug}/activities/:
    get:
      tags:
        - Workspaces
      summary: List workspace activities
      description: Returns all activity log entries for a workspace.
      parameters:
        - in: path
          name: workspaceSlug
          description: URL-safe workspace identifier.
          required: true
          schema:
            description: URL-safe workspace identifier.
            type: string
          style: simple
        - in: query
          name: after
          description: |-
            Cursor pointing to the last item of the previous page.
            Obtain this from the `nextCursor` field in the response.
          schema:
            description: |-
              Cursor pointing to the last item of the previous page.
              Obtain this from the `nextCursor` field in the response.
            type: string
          style: form
        - in: query
          name: limit
          description: 'The maximum number of records to return (1-100, default: 20).'
          schema:
            description: 'The maximum number of records to return (1-100, default: 20).'
            type: integer
            format: uint32
            maximum: 100
            minimum: 1
          style: form
      responses:
        '200':
          description: >-
            Generic paginated response wrapper.


            Provides a consistent structure for all paginated API responses with

            cursor-based pagination support. When `next_cursor` is present,
            there

            are more items to fetch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityPage'
        '401':
          description: >-
            HTTP error response representation with security-conscious design.


            This struct contains all the information needed to serialize an
            error

            response, including the error name, message, HTTP status code,
            resource

            information, and user-friendly messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            HTTP error response representation with security-conscious design.


            This struct contains all the information needed to serialize an
            error

            response, including the error name, message, HTTP status code,
            resource

            information, and user-friendly messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    ActivityPage:
      description: |-
        Generic paginated response wrapper.

        Provides a consistent structure for all paginated API responses with
        cursor-based pagination support. When `next_cursor` is present, there
        are more items to fetch.
      type: object
      properties:
        items:
          description: Items in this page.
          type: array
          items:
            $ref: '#/components/schemas/Activity'
        nextCursor:
          description: Cursor to fetch the next page. Present only when more items exist.
          type: string
        total:
          description: Total count of items matching the query (if requested).
          type: integer
          format: int64
      required:
        - items
    ErrorResponse:
      description: |-
        HTTP error response representation with security-conscious design.

        This struct contains all the information needed to serialize an error
        response, including the error name, message, HTTP status code, resource
        information, and user-friendly messages.
      type: object
      properties:
        message:
          description: User-friendly error message safe for client display
          type: string
        name:
          description: The error name/type identifier
          type: string
        resource:
          description: The resource that the error relates to (optional, set by handler)
          type: string
        suggestion:
          description: Helpful suggestion for resolving the error (optional)
          type: string
        validation:
          description: Validation error details for field-specific errors
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorDetail'
      required:
        - name
        - message
    Activity:
      description: >-
        Response type for a workspace activity.


        The typed payload is nested under `payload`, so an activity is

        `{ id, workspaceSlug, performedBy, payload: { activityType, <params...>
        }, createdAt }`.
      type: object
      properties:
        createdAt:
          description: When the activity occurred.
          type: string
          format: date-time
        id:
          description: Unique activity identifier.
          type: string
          format: uuid
        payload:
          $ref: '#/components/schemas/ActivityPayload'
          description: >-
            The activity type and its typed params, absent when the stored
            params do

            not decode into their `activityType`.
        performedBy:
          description: Account that performed the activity.
          allOf:
            - $ref: '#/components/schemas/AccountRef'
        workspaceSlug:
          description: Handle of the workspace this activity belongs to.
          allOf:
            - $ref: '#/components/schemas/Handle'
      required:
        - id
        - workspaceSlug
        - performedBy
        - createdAt
    ValidationErrorDetail:
      description: Validation error details for field-specific errors.
      type: object
      properties:
        code:
          description: Error code for the validation failure
          type: string
        field:
          description: Field name that failed validation
          type: string
        message:
          description: Human-readable error message
          type: string
        params:
          description: Additional parameters related to the validation error
          type: object
          additionalProperties: true
      required:
        - field
        - code
        - message
    ActivityPayload:
      description: >-
        The typed payload of an audit-log activity, tagged by `activityType`.


        Each variant is one activity type carrying its own params. No rendered
        text is

        included — the client localizes the copy from `activityType` and the
        params.

        The `activityType` values match the `ACTIVITY_TYPE` enum.
      oneOf:
        - description: A workspace was created.
          type: object
          properties:
            activityType:
              type: string
              const: workspace.created
          allOf:
            - $ref: '#/components/schemas/WorkspaceActivityParams'
          required:
            - activityType
        - description: A workspace was updated.
          type: object
          properties:
            activityType:
              type: string
              const: workspace.updated
          allOf:
            - $ref: '#/components/schemas/WorkspaceActivityParams'
          required:
            - activityType
        - description: A workspace was deleted.
          type: object
          properties:
            activityType:
              type: string
              const: workspace.deleted
          allOf:
            - $ref: '#/components/schemas/WorkspaceActivityParams'
          required:
            - activityType
        - description: A member joined the workspace.
          type: object
          properties:
            activityType:
              type: string
              const: member.added
          allOf:
            - $ref: '#/components/schemas/MemberActivityParams'
          required:
            - activityType
        - description: A member was updated.
          type: object
          properties:
            activityType:
              type: string
              const: member.updated
          allOf:
            - $ref: '#/components/schemas/MemberActivityParams'
          required:
            - activityType
        - description: A member was removed.
          type: object
          properties:
            activityType:
              type: string
              const: member.deleted
          allOf:
            - $ref: '#/components/schemas/MemberActivityParams'
          required:
            - activityType
        - description: An invite was created.
          type: object
          properties:
            activityType:
              type: string
              const: invite.created
          allOf:
            - $ref: '#/components/schemas/InviteActivityParams'
          required:
            - activityType
        - description: An invite was accepted.
          type: object
          properties:
            activityType:
              type: string
              const: invite.accepted
          allOf:
            - $ref: '#/components/schemas/InviteActivityParams'
          required:
            - activityType
        - description: An invite was declined.
          type: object
          properties:
            activityType:
              type: string
              const: invite.declined
          allOf:
            - $ref: '#/components/schemas/InviteActivityParams'
          required:
            - activityType
        - description: An invite was canceled.
          type: object
          properties:
            activityType:
              type: string
              const: invite.canceled
          allOf:
            - $ref: '#/components/schemas/InviteActivityParams'
          required:
            - activityType
        - description: A connection was created.
          type: object
          properties:
            activityType:
              type: string
              const: connection.created
          allOf:
            - $ref: '#/components/schemas/ConnectionActivityParams'
          required:
            - activityType
        - description: A connection was updated.
          type: object
          properties:
            activityType:
              type: string
              const: connection.updated
          allOf:
            - $ref: '#/components/schemas/ConnectionActivityParams'
          required:
            - activityType
        - description: A connection was deleted.
          type: object
          properties:
            activityType:
              type: string
              const: connection.deleted
          allOf:
            - $ref: '#/components/schemas/ConnectionActivityParams'
          required:
            - activityType
        - description: A connection sync completed.
          type: object
          properties:
            activityType:
              type: string
              const: connection.sync.completed
          allOf:
            - $ref: '#/components/schemas/ConnectionActivityParams'
          required:
            - activityType
        - description: A connection sync failed.
          type: object
          properties:
            activityType:
              type: string
              const: connection.sync.failed
          allOf:
            - $ref: '#/components/schemas/ConnectionActivityParams'
          required:
            - activityType
        - description: A webhook was created.
          type: object
          properties:
            activityType:
              type: string
              const: webhook.created
          allOf:
            - $ref: '#/components/schemas/WebhookActivityParams'
          required:
            - activityType
        - description: A webhook was updated.
          type: object
          properties:
            activityType:
              type: string
              const: webhook.updated
          allOf:
            - $ref: '#/components/schemas/WebhookActivityParams'
          required:
            - activityType
        - description: A webhook was deleted.
          type: object
          properties:
            activityType:
              type: string
              const: webhook.deleted
          allOf:
            - $ref: '#/components/schemas/WebhookActivityParams'
          required:
            - activityType
        - description: A webhook was triggered.
          type: object
          properties:
            activityType:
              type: string
              const: webhook.triggered
          allOf:
            - $ref: '#/components/schemas/WebhookActivityParams'
          required:
            - activityType
        - description: A file was created.
          type: object
          properties:
            activityType:
              type: string
              const: file.created
          allOf:
            - $ref: '#/components/schemas/FileActivityParams'
          required:
            - activityType
        - description: A file was updated.
          type: object
          properties:
            activityType:
              type: string
              const: file.updated
          allOf:
            - $ref: '#/components/schemas/FileActivityParams'
          required:
            - activityType
        - description: A file was deleted.
          type: object
          properties:
            activityType:
              type: string
              const: file.deleted
          allOf:
            - $ref: '#/components/schemas/FileActivityParams'
          required:
            - activityType
        - description: A file was verified.
          type: object
          properties:
            activityType:
              type: string
              const: file.verified
          allOf:
            - $ref: '#/components/schemas/FileActivityParams'
          required:
            - activityType
        - description: A pipeline was created.
          type: object
          properties:
            activityType:
              type: string
              const: pipeline.created
          allOf:
            - $ref: '#/components/schemas/PipelineActivityParams'
          required:
            - activityType
        - description: A pipeline was updated.
          type: object
          properties:
            activityType:
              type: string
              const: pipeline.updated
          allOf:
            - $ref: '#/components/schemas/PipelineActivityParams'
          required:
            - activityType
        - description: A pipeline was deleted.
          type: object
          properties:
            activityType:
              type: string
              const: pipeline.deleted
          allOf:
            - $ref: '#/components/schemas/PipelineActivityParams'
          required:
            - activityType
        - description: A pipeline run was started.
          type: object
          properties:
            activityType:
              type: string
              const: pipeline.run.started
          allOf:
            - $ref: '#/components/schemas/PipelineRunActivityParams'
          required:
            - activityType
        - description: A pipeline run finished detection.
          type: object
          properties:
            activityType:
              type: string
              const: pipeline.run.analyzed
          allOf:
            - $ref: '#/components/schemas/PipelineRunActivityParams'
          required:
            - activityType
        - description: A pipeline run completed.
          type: object
          properties:
            activityType:
              type: string
              const: pipeline.run.completed
          allOf:
            - $ref: '#/components/schemas/PipelineRunActivityParams'
          required:
            - activityType
        - description: A pipeline run failed.
          type: object
          properties:
            activityType:
              type: string
              const: pipeline.run.failed
          allOf:
            - $ref: '#/components/schemas/PipelineRunActivityParams'
          required:
            - activityType
        - description: A policy was created.
          type: object
          properties:
            activityType:
              type: string
              const: policy.created
          allOf:
            - $ref: '#/components/schemas/PolicyActivityParams'
          required:
            - activityType
        - description: A policy was updated.
          type: object
          properties:
            activityType:
              type: string
              const: policy.updated
          allOf:
            - $ref: '#/components/schemas/PolicyActivityParams'
          required:
            - activityType
        - description: A policy was deleted.
          type: object
          properties:
            activityType:
              type: string
              const: policy.deleted
          allOf:
            - $ref: '#/components/schemas/PolicyActivityParams'
          required:
            - activityType
    AccountRef:
      description: >-
        Public reference to the account behind a resource — whoever created it,

        uploaded it, triggered it, or performed it.


        Reused across resource responses so an account is always presented the
        same

        way: a handle plus an optional avatar.
      type: object
      properties:
        avatarUrl:
          description: Serve path of the account's avatar, when set.
          type: string
        displayName:
          description: Human-readable display name, when set.
          type: string
        username:
          description: Handle of the account.
          allOf:
            - $ref: '#/components/schemas/Handle'
      required:
        - username
    Handle:
      description: >-
        Lowercase, dash-separated identifier used in URLs and as account
        handles.
      type: string
      maxLength: 32
      minLength: 3
      pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
    WorkspaceActivityParams:
      description: Params of a workspace-scoped activity (`workspace.*`).
      type: object
      properties:
        workspaceSlug:
          description: Slug of the workspace acted on.
          allOf:
            - $ref: '#/components/schemas/Handle'
      required:
        - workspaceSlug
    MemberActivityParams:
      description: Params of a member activity (`member.*`).
      type: object
      properties:
        memberUsername:
          description: Username of the member acted on.
          allOf:
            - $ref: '#/components/schemas/Handle'
      required:
        - memberUsername
    InviteActivityParams:
      description: Params of an invite activity (`invite.*`).
      type: object
      properties:
        email:
          description: Email the invite was addressed to.
          type: string
        inviteId:
          description: Id of the invite.
          type: string
          format: uuid
      required:
        - inviteId
        - email
    ConnectionActivityParams:
      description: Params of a connection activity (`connection.*`).
      type: object
      properties:
        connectionId:
          description: Id of the connection.
          type: string
          format: uuid
      required:
        - connectionId
    WebhookActivityParams:
      description: Params of a webhook activity (`webhook.*`).
      type: object
      properties:
        webhookId:
          description: Id of the webhook.
          type: string
          format: uuid
      required:
        - webhookId
    FileActivityParams:
      description: Params of a file activity (`file.*`).
      type: object
      properties:
        fileId:
          description: Id of the file.
          type: string
          format: uuid
        fileName:
          description: Display name of the file.
          type: string
      required:
        - fileId
        - fileName
    PipelineActivityParams:
      description: Params of a pipeline activity (`pipeline.*`, non-run).
      type: object
      properties:
        pipelineSlug:
          description: Slug of the pipeline.
          allOf:
            - $ref: '#/components/schemas/Handle'
      required:
        - pipelineSlug
    PipelineRunActivityParams:
      description: Params of a pipeline-run activity (`pipeline.run.*`).
      type: object
      properties:
        pipelineSlug:
          description: Slug of the owning pipeline.
          allOf:
            - $ref: '#/components/schemas/Handle'
        runId:
          description: Id of the run.
          type: string
          format: uuid
      required:
        - pipelineSlug
        - runId
    PolicyActivityParams:
      description: Params of a policy activity (`policy.*`).
      type: object
      properties:
        policyId:
          description: Id of the policy.
          type: string
          format: uuid
      required:
        - policyId

````