# List workspaces

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /webhook/partner-list-workspace:
    post:
      summary: List workspaces
      deprecated: false
      description: >-
        These endpoints allow email infrastructure provider partners to
        programmatically initiate the Google/Microsoft OAuth login flow to add
        an account to PlusVibe.
      operationId: >-
        For Email Infra Provider
        Partner_pipl-partner-google-oauth-url-api/list-workspaces-for-a-partner
      tags:
        - For Email Infra Provider Partner
        - For Email Infra Provider Partner
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                flow:
                  type: string
                  description: Flow type. Currently only `"app_user"` is supported.
                  examples:
                    - app_user
                pipl_username:
                  type: string
                  description: Login Email
                  format: email
                  examples:
                    - user@email.com
                pipl_password:
                  type: string
                  description: Password
                  examples:
                    - A1b2c3d4!
              required:
                - flow
                - pipl_username
                - pipl_password
              x-apidog-orders:
                - flow
                - pipl_username
                - pipl_password
      responses:
        '200':
          description: Successfully listed workspaces
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: ''
                    examples:
                      - 1
                  message:
                    type: string
                    description: ''
                    examples:
                      - success
                  data:
                    type: array
                    description: ''
                    items:
                      type: object
                      properties:
                        org_id:
                          type: string
                          description: Owner Organization of the workspace
                          examples:
                            - 65099a0dd96fae8ab61130be
                        workspace_id:
                          type: string
                          description: Workspace Id
                          examples:
                            - 66c5860c0d3839cddfe96a31
                        workspace_name:
                          type: string
                          description: Workspace Name
                          examples:
                            - Example Workspace Name
                        workspace_status:
                          type: string
                          description: |
                            Workspace Status
                          examples:
                            - ACTIVE
                      x-apidog-orders:
                        - org_id
                        - workspace_id
                        - workspace_name
                        - workspace_status
                x-apidog-orders:
                  - code
                  - message
                  - data
          headers: {}
          x-apidog-name: OK
      security:
        - ApiKeyAuth: []
          x-apidog:
            schemeGroups:
              - id: uS5KiuC4wfZHK42AzOfA_
                schemeIds:
                  - ApiKeyAuth
            required: true
            use:
              id: uS5KiuC4wfZHK42AzOfA_
            scopes:
              uS5KiuC4wfZHK42AzOfA_:
                ApiKeyAuth: []
      x-apidog-folder: For Email Infra Provider Partner
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/929054/apis/api-17238037-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: []

```