# Get workspaces

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /authenticate:
    get:
      summary: Get workspaces
      deprecated: false
      description: Test the provided API key and returns the list of accessible workspaces.
      operationId: Workspace_workspace/get-workspaces
      tags:
        - Workspace
        - Workspace
      parameters:
        - name: x-api-key
          in: header
          description: Your PlusVibe.ai account's API Key
          required: true
          example: your-api-key
          schema:
            type: string
            description: Your PlusVibe.ai account's API Key
            default: ''
            examples:
              - your-api-key
      responses:
        '200':
          description: Successful authentication
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  workspaces:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        name:
                          type: string
                        01JW0G0CD9F9YNGY86ZKEKTNV3:
                          type: string
                      required:
                        - _id
                        - name
                        - 01JW0G0CD9F9YNGY86ZKEKTNV3
                      x-apidog-orders:
                        - _id
                        - name
                        - 01JW0G0CD9F9YNGY86ZKEKTNV3
                required:
                  - status
                  - workspaces
                x-apidog-orders:
                  - status
                  - workspaces
              example:
                status: success
                workspaces:
                  - _id: 65f3c92d3dbe5dbb35374a9a
                    name: Yaro's Workspace
                  - _id: 65f4c93e4dce6dba36485b2b
                    name: Yaro's second workspace
          headers: {}
          x-apidog-name: OK
        '400':
          description: Invalid API key or request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: ''
                    examples:
                      - >-
                        The provided API key is invalid. Please verify that your
                        API key is correct and try again.
                  message:
                    type: string
                    description: ''
                    examples:
                      - >-
                        The provided API key is invalid. Please verify that your
                        API key is correct and try again.
                required:
                  - error
                  - message
                x-apidog-orders:
                  - error
                  - message
          headers: {}
          x-apidog-name: Bad Request
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Server Error
      security:
        - ApiKeyAuth: []
          x-apidog:
            schemeGroups:
              - id: uS5KiuC4wfZHK42AzOfA_
                schemeIds:
                  - ApiKeyAuth
            required: true
            use:
              id: uS5KiuC4wfZHK42AzOfA_
            scopes:
              uS5KiuC4wfZHK42AzOfA_:
                ApiKeyAuth: []
      x-apidog-folder: Workspace
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/929054/apis/api-17237993-run
components:
  schemas: {}
  securitySchemes:
    ApiKeyAuth:
      type: apikey
      in: header
      name: x-api-key
      description: |
        API key issued in the PlusVibe dashboard. The server reads it
        from the `x-api-key` header and injects it into the request as
        the `api_key` query parameter, which is why you will see
        `api_key` referenced in validation errors.
    apiKey:
      type: apikey
      in: body
      name: api_key
      description: API key passed in request body
servers:
  - url: https://api.plusvibe.ai/api/v1
    description: Prod Env
security:
  - ApiKeyAuth: []
    x-apidog:
      schemeGroups:
        - id: uS5KiuC4wfZHK42AzOfA_
          schemeIds:
            - ApiKeyAuth
      required: true
      use:
        id: uS5KiuC4wfZHK42AzOfA_
      scopes:
        uS5KiuC4wfZHK42AzOfA_:
          ApiKeyAuth: []

```