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

# List workspace changes

> Lists the changes of the workspace, newest first: the workspace was created, renamed, or got a new website, and members joined, changed role, or left. To get the next page, send the nextCursor of the last page. Needs the `workspace:read` scope.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspace-changes
openapi: 3.1.0
info:
  title: VMS API
  version: 1.0.0
  description: >-
    The public API of a VMS workspace. Each request needs an API key of the
    workspace in the Authorization header.
servers:
  - url: https://vms.dev/api
    description: The VMS API
security:
  - apiKey: []
paths:
  /v1/workspace-changes:
    get:
      tags:
        - Workspace
      summary: List workspace changes
      description: >-
        Lists the changes of the workspace, newest first: the workspace was
        created, renamed, or got a new website, and members joined, changed
        role, or left. To get the next page, send the nextCursor of the last
        page. Needs the `workspace:read` scope.
      operationId: listWorkspaceChanges
      parameters:
        - in: query
          name: limit
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
        - in: query
          name: cursor
          schema:
            anyOf:
              - type: string
                minLength: 1
                maxLength: 512
              - type: 'null'
      responses:
        '200':
          description: One page of workspace changes.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkspaceChange'
                  nextCursor:
                    type:
                      - string
                      - 'null'
                required:
                  - data
                  - nextCursor
                additionalProperties: false
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key is missing, not correct, revoked, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The API key does not have the scope of the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: The API key sent more than 1,200 requests in one minute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    WorkspaceChange:
      type: object
      properties:
        id:
          type: string
          example: wsc_06d8k3m7q2v9x4b1n5c0e8f2ja
        kind:
          type: string
          enum:
            - workspace.created
            - member.joined
            - member.removed
            - member.role_changed
            - workspace.name_changed
            - workspace.website_changed
        data:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type:
              - string
              - 'null'
          example:
            name: Acme Inc
            previousName: Acme
        createdAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
      required:
        - id
        - kind
        - data
        - createdAt
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: no_capacity
            message:
              type: string
            requestId:
              type:
                - string
                - 'null'
            retryAfterSeconds:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            sandboxId:
              description: The sandbox that the error is about.
              type: string
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key that starts with vms_. Make one in Settings > API keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.