# List clients

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /client/:
    get:
      summary: List clients
      deprecated: false
      description: Fetch all clients in a workspace.
      tags:
        - Client Access
      parameters:
        - name: workspace_id
          in: query
          description: ''
          required: true
          example: 65f99a0dd96fae8ab61130c0
          schema:
            type: string
      responses:
        '200':
          description: List of clients
          content:
            application/json:
              schema:
                type: object
                properties:
                  clients:
                    type: array
                    items:
                      $ref: '#/components/schemas/ClientListItem'
                x-apidog-orders:
                  - clients
                x-apidog-ignore-properties: []
              example:
                clients:
                  - client_id: 70218d5e05561a3877dcb77f
                    first_name: Nova
                    last_name: Smith
                    client_email: nova.smith@example.com
                    client_business_name: Nova Consulting Ltd
                    status: ACTIVE
                    client_permissions:
                      - org_id: 65f99a0dd96fae8ab61130bf
                        workspace_id: 65f99a0dd96fae8ab61130c0
                        permissions:
                          - FULL_ACCESS
                        hide_labels: []
                        workspace_name: Marketing Workspace
                    created_at: '2025-05-30T03:24:36.455Z'
                    modified_at: '2025-10-27T13:03:13.055Z'
          headers: {}
          x-apidog-name: OK
      security:
        - ApiKeyAuth: []
          x-apidog:
            schemeGroups:
              - id: TiQQJTo_qaQX0Nm2ydXFT
                schemeIds:
                  - ApiKeyAuth
            required: true
            use:
              id: TiQQJTo_qaQX0Nm2ydXFT
            scopes:
              TiQQJTo_qaQX0Nm2ydXFT:
                ApiKeyAuth: []
      x-apidog-folder: Client Access
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/929054/apis/api-24563842-run
components:
  schemas:
    ClientListItem:
      type: object
      properties:
        client_id:
          type: string
          examples:
            - 70218d5e05561a3877dcb77f
        first_name:
          type: string
          examples:
            - Nova
        last_name:
          type: string
          examples:
            - Smith
        client_email:
          type: string
          examples:
            - nova.smith@example.com
        client_business_name:
          type: string
          examples:
            - Nova Consulting Ltd
        status:
          type: string
          examples:
            - ACTIVE
        client_permissions:
          type: array
          items:
            type: object
            properties:
              org_id:
                type: string
                examples:
                  - 65f99a0dd96fae8ab61130bf
              workspace_id:
                type: string
                examples:
                  - 65f99a0dd96fae8ab61130c0
              permissions:
                type: array
                items:
                  type: string
                examples:
                  - - CAMPAIGN_LIST
                    - UNIBOX_LIST
              hide_labels:
                type: array
                items:
                  type: string
                examples:
                  - []
              workspace_name:
                type: string
                examples:
                  - Marketing Workspace
            x-apidog-orders:
              - org_id
              - workspace_id
              - permissions
              - hide_labels
              - workspace_name
            x-apidog-ignore-properties: []
        created_at:
          type: string
          format: date-time
          examples:
            - '2025-10-12T09:15:44.000Z'
        modified_at:
          type: string
          format: date-time
          examples:
            - '2025-11-20T14:07:17.901Z'
      x-apidog-orders:
        - client_id
        - first_name
        - last_name
        - client_email
        - client_business_name
        - status
        - client_permissions
        - created_at
        - modified_at
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  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: []

```