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

# Search connected orgs with health signals (paginated)

> Find, filter, sort and page through the calling partner's connected orgs (its customers), each with the health signals the Partner Admin console shows: `health.status` — `new`…



## OpenAPI

````yaml get /partner-analytics/orgs/search
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /partner-analytics/orgs/search:
    get:
      summary: Search connected orgs with health signals (paginated)
      description: >-
        Find, filter, sort and page through the calling partner's connected orgs
        (its customers), each with the health signals the Partner Admin console
        shows: `health.status` — `new` (connected < 7 days, no sessions yet),
        `setup_incomplete` (no knowledge sources and no actions), `inactive` (no
        session in the last 30 days), `healthy` (everything else) — plus
        `members`, `data_sources`, `has_ai_training`, `has_actions`,
        `sessions_30d`, `total_sessions`, `last_session_at`, and per-channel
        connected flags (`chat`, `email`, `whatsapp`, `instagram`, `messenger`,
        `sms`, `voice`). `q` matches name or external_id; `status`, `tags`,
        `channels` and `addons` are comma-separated (tags match ANY, channels
        and add-ons match ALL; add-ons are `fareharbor`, `shopify`, `jira`);
        `has_ai` / `has_actions` are 'true' / 'false'; `archived=only` lists the
        partner's archived orgs, which are hidden unless asked for. Max 100 rows
        per page (`limit`/`offset`); `total` is the filtered count. For volume,
        quality and behaviour beyond these signals use
        `runPartnerAnalyticsQuery`; for the full id → name roster use
        `listPartnerOrgs`. Only available to partner admin organizations (403
        otherwise).
      operationId: searchPartnerOrgs
      parameters:
        - schema:
            default: 50
            type: number
            minimum: 1
            maximum: 100
          in: query
          name: limit
          required: false
        - schema:
            default: 0
            type: number
            minimum: 0
          in: query
          name: offset
          required: false
        - schema:
            type: string
            maxLength: 200
          in: query
          name: q
          required: false
        - schema:
            type: string
            maxLength: 200
          in: query
          name: status
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: has_ai
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: has_actions
          required: false
        - schema:
            type: string
            maxLength: 1000
          in: query
          name: tags
          required: false
        - schema:
            type: string
            maxLength: 100
          in: query
          name: channels
          required: false
        - schema:
            type: string
            maxLength: 100
          in: query
          name: addons
          required: false
        - schema:
            type: string
            enum:
              - only
          in: query
          name: archived
          required: false
        - schema:
            default: created_at
            type: string
            enum:
              - created_at
              - name
              - members
              - data_sources
              - sessions_30d
              - total_sessions
              - last_session_at
          in: query
          name: sort_by
          required: false
        - schema:
            default: desc
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sort_dir
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchPartnerOrgsResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    SearchPartnerOrgsResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SearchPartnerOrgsResponseDto'
      type: object
      properties:
        partner:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
          additionalProperties: false
        data:
          type: array
          items:
            $ref: '#/components/schemas/PartnerOrgHealthDto'
        total:
          type: number
        limit:
          type: number
        offset:
          type: number
      required:
        - partner
        - data
        - total
        - limit
        - offset
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    PartnerOrgHealthDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/PartnerOrgHealthDto'
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        external_id:
          type:
            - string
            - 'null'
        website:
          type:
            - string
            - 'null'
        logo_url:
          type:
            - string
            - 'null'
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        tags:
          type: array
          items:
            type: string
        health:
          type: object
          properties:
            status:
              type: string
              enum:
                - healthy
                - setup_incomplete
                - inactive
                - new
            members:
              type: number
            data_sources:
              type: number
            has_ai_training:
              type: boolean
            has_actions:
              type: boolean
            sessions_30d:
              type: number
            total_sessions:
              type: number
            last_session_at:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
          required:
            - status
            - members
            - data_sources
            - has_ai_training
            - has_actions
            - sessions_30d
            - total_sessions
            - last_session_at
          additionalProperties: false
        channels:
          type: object
          properties:
            chat:
              type: boolean
            email:
              type: boolean
            whatsapp:
              type: boolean
            instagram:
              type: boolean
            messenger:
              type: boolean
            sms:
              type: boolean
            voice:
              type: boolean
          required:
            - chat
            - email
            - whatsapp
            - instagram
            - messenger
            - sms
            - voice
          additionalProperties: false
      required:
        - id
        - name
        - external_id
        - website
        - logo_url
        - created_at
        - tags
        - health
        - channels
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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