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

# List tenants

> Lists your tenants, 100 to a page. Needs the `tenants:write` scope.



## OpenAPI

````yaml /openapi/partner.yaml get /api/v1/partner/tenants/
openapi: 3.1.0
info:
  title: ImpelLabs Partner API
  version: '1'
  description: >-
    The Partner API provisions customer businesses (tenants) and runs their
    channels, conversations and templates from your own product. Call it from
    your server with a partner key. Every path ends with a slash.
servers:
  - url: https://api.impellabs.tech
security:
  - bearer: []
tags:
  - name: Keys
    description: Your partner API keys.
  - name: Tenants
    description: Customer businesses, their channels, conversations and templates.
  - name: Webhooks
    description: Where your tenants' events go.
  - name: WhatsApp sign-up
    description: The settings of the hosted WhatsApp sign-up.
paths:
  /api/v1/partner/tenants/:
    get:
      tags:
        - Tenants
      summary: List tenants
      description: Lists your tenants, 100 to a page. Needs the `tenants:write` scope.
      operationId: get_api_v1_partner_tenants
      parameters:
        - name: q
          in: query
          required: false
          description: Keeps tenants whose name or `external_ref` contains this text.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Send `active` to leave out offboarded tenants.
          schema:
            type: string
            enum:
              - active
        - name: page
          in: query
          required: false
          description: The page number, from 1.
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                results:
                  - external_ref: acme-001
                    id: 2f1c0b9e-0000-4000-8000-000000000000
                    name: Acme Dental
                    plan: free
                    status: active
                    billed_to: partner
                    billing_mode: payg
                    monthly_credit_cap: 5000
                    is_active: true
                    created_at: '2026-01-15T09:30:00+00:00'
                page: 1
                page_size: 100
                total: 1
                has_more: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        4XX:
          description: The request is not valid or not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    Unauthorized:
      description: The credentials are missing, wrong, expired or revoked.
    Forbidden:
      description: These credentials may not do this.
  schemas:
    Error:
      type: object
      description: >-
        An error. Most errors carry `detail`. Some carry `error` with `code` and
        `message`.
      properties:
        detail:
          type: string
        code:
          type: string
        field:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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