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

# List clients, or get one

> List your client workspaces, or pass `id` for one with its feature settings and, with `include`, its details, limits, activity and people.



## OpenAPI

````yaml /openapi.json get /api/v1/public/partner/clients
openapi: 3.1.0
info:
  description: >-
    Customer-facing API for managing outreach, leads, conversations, voice
    agents, knowledge bases, analytics, and webhooks.
  title: Sendora Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.sendora.ai
security: []
tags:
  - description: Leads, lead lists, importing, enriching and finding new prospects.
    name: Leads
  - description: Build, run and measure outreach, and enroll leads.
    name: Campaigns
  - description: Read and send messages, and manage who must not be contacted.
    name: Conversations
  - description: >-
      Voice and chat agents, their tools, knowledge bases, voices and website
      widgets.
    name: Agents
  - description: >-
      Start calls, and manage phone numbers, SMS registration, sending accounts
      and email domains.
    name: Calls and numbers
  - description: Webhooks, jobs, analytics and the Copilot assistant.
    name: Platform
  - description: Manage client workspaces, plans and branding.
    name: Agency
paths:
  /api/v1/public/partner/clients:
    get:
      tags:
        - Agency
      summary: List clients, or get one
      description: >-
        List your client workspaces, or pass `id` for one with its feature
        settings and, with `include`, its details, limits, activity and people.
      operationId: list_clients_api_v1_public_partner_clients_get
      parameters:
        - description: Return this one client with its features.
          in: query
          name: id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Return this one client with its features.
            title: Id
        - description: >-
            Without id: revenue adds the trailing 30 day overview. With id: a
            comma list of details (status, plan, owner, health, 30 days of usage
            and revenue), limits (monthly caps and channel access), audit (what
            the client did and what you changed) and users (the client's own
            people).
          in: query
          name: include
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Without id: revenue adds the trailing 30 day overview. With id: a
              comma list of details (status, plan, owner, health, 30 days of
              usage and revenue), limits (monthly caps and channel access),
              audit (what the client did and what you changed) and users (the
              client's own people).
            title: Include
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
        - in: header
          name: Authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - items:
                      $ref: '#/components/schemas/PublicPartnerClient'
                    type: array
                  - $ref: '#/components/schemas/ClientsWithRevenue'
                  - $ref: '#/components/schemas/PublicClientFeature'
                title: Response List Clients Api V1 Public Partner Clients Get
          description: Successful Response
        '401':
          description: The X-API-Key header is missing, invalid, expired, or revoked.
        '402':
          description: >-
            The workspace is suspended for billing, or the request would exceed
            a plan or usage limit.
        '403':
          description: >-
            The key is valid but lacks the required scope, or the workspace has
            no active plan, lacks the entitlement, or has this feature turned
            off or view-only.
        '410':
          description: The workspace behind this key has been deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          description: >-
            An unexpected Sendora error occurred. Retry only if the operation is
            safe to repeat.
        '503':
          description: >-
            An entitlement or billing check is temporarily unavailable. Retry
            after the Retry-After interval.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: >-
            curl -X GET 'https://api.sendora.ai/api/v1/public/partner/clients'
            -H "X-API-Key: $SENDORA_API_KEY"
        - label: Python
          lang: python
          source: |-
            import requests

            url = 'https://api.sendora.ai/api/v1/public/partner/clients'
            headers = {'X-API-Key': '$SENDORA_API_KEY'}
            response = requests.get(url, headers=headers)
            response.raise_for_status()
            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/partner/clients", {
              method: "GET",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY },
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
        - label: Go
          lang: go
          source: >-
            req, err := http.NewRequest("GET",
            "https://api.sendora.ai/api/v1/public/partner/clients", nil)

            if err != nil { log.Fatal(err) }

            req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))

            resp, err := http.DefaultClient.Do(req)

            if err != nil { log.Fatal(err) }

            defer resp.Body.Close()
components:
  schemas:
    PublicPartnerClient:
      properties:
        billing_mode:
          default: billing_unavailable
          description: Billing mode returned by the Sendora API.
          enum:
            - self_managed
            - client_prepaid
            - billing_unavailable
          title: Billing Mode
          type: string
        campaign_count:
          default: 0
          description: Campaign count returned by the Sendora API.
          title: Campaign Count
          type: integer
        client_billing_status:
          anyOf:
            - type: string
            - type: 'null'
          description: Client billing status returned by the Sendora API.
          title: Client Billing Status
        client_package_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Client package name returned by the Sendora API.
          title: Client Package Name
        created_at:
          description: Created at returned by the Sendora API.
          title: Created At
          type: string
        custom_domain:
          anyOf:
            - type: string
            - type: 'null'
          description: Custom domain returned by the Sendora API.
          title: Custom Domain
        health:
          default: unknown
          description: Health returned by the Sendora API.
          title: Health
          type: string
        id:
          description: >-
            The client workspace's public id. Pass it as `client_id` to the
            other agency endpoints.
          title: Id
          type: string
        is_owner_workspace:
          default: false
          description: Is owner workspace returned by the Sendora API.
          title: Is Owner Workspace
          type: boolean
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Logo url returned by the Sendora API.
          title: Logo Url
        monthly_revenue:
          anyOf:
            - type: number
            - type: 'null'
          description: Monthly revenue returned by the Sendora API.
          title: Monthly Revenue
        name:
          description: Name returned by the Sendora API.
          title: Name
          type: string
        owner_email:
          anyOf:
            - type: string
            - type: 'null'
          description: Owner email returned by the Sendora API.
          title: Owner Email
        owner_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Owner name returned by the Sendora API.
          title: Owner Name
        plan:
          anyOf:
            - type: string
            - type: 'null'
          description: Plan returned by the Sendora API.
          title: Plan
        slug:
          anyOf:
            - type: string
            - type: 'null'
          description: Slug returned by the Sendora API.
          title: Slug
        status:
          description: Status returned by the Sendora API.
          title: Status
          type: string
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          description: Updated at returned by the Sendora API.
          title: Updated At
      required:
        - id
        - name
        - status
        - created_at
      title: PublicPartnerClient
      type: object
    ClientsWithRevenue:
      additionalProperties: true
      properties:
        clients:
          description: Clients returned by the Sendora API.
          items:
            $ref: '#/components/schemas/PublicPartnerClient'
          title: Clients
          type: array
        overview:
          description: Overview returned by the Sendora API.
          title: Overview
          type: object
      required:
        - clients
        - overview
      title: ClientsWithRevenue
      type: object
    PublicClientFeature:
      properties:
        enabled:
          description: Enabled returned by the Sendora API.
          title: Enabled
          type: boolean
        key:
          description: Key returned by the Sendora API.
          title: Key
          type: string
      required:
        - key
        - enabled
      title: PublicClientFeature
      type: object
    HTTPValidationError:
      properties:
        detail:
          description: Detail returned by the Sendora API.
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      required: []
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        loc:
          description: Loc returned by the Sendora API.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          description: Msg returned by the Sendora API.
          title: Message
          type: string
        type:
          description: Type returned by the Sendora API.
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Customer API key created in the Sendora dashboard.
      in: header
      name: X-API-Key
      type: apiKey

````

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