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

# List Spaces

> Return a paginated list of Spaces within the authorized Workspace.

<Accordion title="Required scopes (OAuth 2.0)" icon="key">
  This endpoint requires one of the following scopes:

  `workspaces.read` or `workspaces`
</Accordion>


## OpenAPI

````yaml GET /workspaces/spaces
openapi: 3.1.0
info:
  version: 1.0.0
  title: Lumin API Reference
  description: >
    The Lumin API Reference provides a comprehensive set of tools to integrate
    document workflows — including editing, eSignatures, and automation — into
    your applications.


    Useful links:

    - [Document Repository](https://github.com/luminpdf/luminsign-docs)

    - [API
    Definition](https://github.com/luminpdf/luminsign-docs/blob/main/openapi.yaml)

    - [Authentication Guide](/tabs/guides/authentication/overview)
  termsOfService: https://www.luminpdf.com/terms-of-use/
  contact:
    name: API Support
    email: integration@luminpdf.com
    url: https://help.luminpdf.com
servers:
  - url: https://api.luminpdf.com/v1
    description: Production server
security: []
tags:
  - name: Signature Requests
    description: Everything about Signature Requests
  - name: Users
    description: Everything about Users
  - name: Templates
    description: Everything about Templates
  - name: Documents
    description: Everything about Documents
  - name: Workspaces
    description: Everything about Workspaces
  - name: Agreements
    description: Everything about Agreements
paths:
  /workspaces/spaces:
    get:
      tags:
        - Workspaces
      summary: List Spaces
      description: Return a paginated list of Spaces within the authorized Workspace.
      parameters:
        - name: page
          in: query
          description: Specify which page of the dataset to return (min = 1).
          schema:
            type: integer
            minimum: 1
            default: 1
          required: false
        - name: limit
          in: query
          description: 'Specify how many records to return per page: one of 10, 25, 50.'
          schema:
            type: integer
            enum:
              - 10
              - 25
              - 50
            default: 25
          required: false
      responses:
        '200':
          description: Returns the list of Spaces in the Workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpacesListResponse'
              example:
                page: 1
                limit: 25
                total_count: 3
                data:
                  - space_id: 69d74983d0cbaa0977be7997
                    name: Sales Team
                    role_of_user: admin
                    total_members: 12
                    created_at: '2026-04-09T06:38:59.381Z'
                  - space_id: 68595b53e8013297be427871
                    name: Engineering
                    role_of_user: member
                    total_members: 8
                    created_at: '2025-12-01T10:15:30.000Z'
                  - space_id: 668b6900aa86960c33b24147
                    name: Partner Program
                    role_of_user: member
                    total_members: 5
                    created_at: '2025-07-08T03:54:17.521Z'
        4XX:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKey: []
        - BearerAuth:
            - workspaces.read
        - BearerAuth:
            - workspaces
components:
  schemas:
    SpacesListResponse:
      type: object
      properties:
        page:
          type: integer
          description: The current page of results being returned.
        limit:
          type: integer
          description: The maximum number of records shown per page (e.g., 10, 25, or 50).
        total_count:
          type: integer
          description: The total number of Spaces in the Workspace.
        data:
          type: array
          description: List of Spaces returned for the requested page.
          items:
            $ref: '#/components/schemas/Space'
    Error:
      type: object
      required:
        - error_code
        - error_message
      properties:
        error_code:
          type: string
          description: The system error code.
        error_message:
          type: string
          description: The human-readable error message.
    Space:
      type: object
      properties:
        space_id:
          type: string
          description: The unique identifier of the Space.
        name:
          type: string
          description: The name of the Space.
        role_of_user:
          type: string
          description: The role of the authenticated user in this Space.
          enum:
            - admin
            - member
        total_members:
          type: integer
          description: The total number of members in the Space.
        created_at:
          type: string
          format: date-time
          description: The timestamp when the Space was created (ISO 8601).
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >
        Provide your API key in the `X-API-Key` header, e.g., `X-API-Key:
        YOUR_API_KEY`.
    BearerAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.luminpdf.com/oauth2/auth
          tokenUrl: https://auth.luminpdf.com/oauth2/token
          scopes:
            openid: >-
              Retrieve basic identity details (username, email, profile
              picture).
            offline_access: Request a refresh token for long-lived access. Private apps only.
            profile.read: View basic user profile information.
            workspaces: View and manage Workspaces and Spaces.
            workspaces.read: View information about the authenticated user's Workspace.
            templates: View and manage templates in a Workspace.
            pdf:files: Create, edit, and delete PDF files in a Workspace.
            pdf:files.read: Retrieve PDF documents stored in a Workspace.
            sign:requests: Create, update, or view signature requests.
            sign:requests.read: Retrieve signature requests.
            agreements: Create, update, or delete AgreementGen documents.
      description: >
        OAuth 2.0 authorization code flow. Provide your access token in the
        `Authorization` header, e.g., `Authorization: Bearer <token>`. See the
        [OAuth 2.0 guide](/tabs/guides/authentication/oauth2) for details.

````