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

# List Organizations

> List organizations for the authenticated user



## OpenAPI

````yaml /api-reference/swagger.yml get /v2/orgs
openapi: 3.0.0
info:
  version: 1.0.0
  title: Prisme.ai APIs
  description: Prisme.ai APIs specifications
  termsOfService: https://www.prisme.ai/mentions-legales
  contact:
    name: Prisme.ai Support Team
    email: support@prisme.ai
    url: https://www.prisme.ai
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.studio.prisme.ai
    description: Prisme.ai Cloud
  - url: https://{customDomain}
    description: Self-hosted Prisme.ai instance
    variables:
      customDomain:
        default: api.your-prisme-instance.com
        description: API hostname of your self-hosted Prisme.ai deployment
  - url: http://localhost:3001
    description: Local development
security:
  - BearerAuth: []
  - OrgApiKeyAuth: []
  - BearerAuth: []
    OrgApiKeyAuth: []
tags:
  - name: API Gateway
    description: >-
      Authentication, session management, SSO providers, and user profile
      endpoints.
  - name: Prisme.ai Workspaces
    description: >-
      CRUD operations for workspaces and their resources (pages, apps,
      automations, imports, variables).
  - name: Prisme.ai Runtime
    description: Execute workspace automations and manage their runtime lifecycle.
  - name: Prisme.ai Events
    description: Event ingestion, delivery, and subscription filtering across the platform.
  - name: Organizations
    description: >-
      Manage organizations, members, roles, invites, groups, and org-level
      service accounts.
  - name: Subscriptions
    description: >-
      Manage organization subscription plans and tier assignments (SuperAdmin
      only).
  - name: Secrets
    description: Read and patch encrypted key-value secrets scoped to a workspace.
  - name: ApiKeys
    description: Create, list, rotate, and validate workspace-scoped API keys.
  - name: Permissions
    description: >-
      Share or unshare resources (workspaces, pages, …) with users via roles or
      fine-grained rules.
  - name: Monitoring
    description: Platform readiness checks across services (SuperAdmin only).
  - name: AuthProviders
paths:
  /v2/orgs:
    get:
      tags:
        - Organizations
      summary: List Organizations
      description: List organizations for the authenticated user
      operationId: listOrganizations
      parameters:
        - name: limit
          in: query
          schema:
            type: number
        - name: page
          in: query
          schema:
            type: number
        - name: search
          in: query
          description: Search organizations by name
          schema:
            type: string
        - name: status
          in: query
          description: Filter organizations by status
          schema:
            type: string
            enum:
              - active
              - suspended
        - name: sort
          in: query
          description: Sort field and direction, e.g. -createdAt
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Organization'
                  total:
                    type: number
        '401':
          description: AuthenticationError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
components:
  schemas:
    Organization:
      type: object
      required:
        - name
        - slug
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        description:
          type: string
        photo:
          type: string
        status:
          type: string
          enum:
            - active
            - suspended
        domains:
          type: array
          items:
            type: string
        branding:
          type: object
          additionalProperties: true
          properties:
            version:
              type: string
            platformName:
              type: string
            description:
              type: string
            logo:
              type: object
              properties:
                light:
                  type: string
                dark:
                  type: string
            favicon:
              type: string
            colors:
              type: object
              properties:
                primary:
                  type: string
                secondary:
                  type: string
                accent:
                  type: string
            fonts:
              type: object
              properties:
                heading:
                  type: string
                body:
                  type: string
            customCssUrl:
              type: string
            customCssInline:
              type: string
        navigation:
          $ref: '#/components/schemas/Navigation'
        joinRules:
          type: array
          description: >-
            Auto-join rules. Each item is an OR case with AND-chained conditions
            in rules[]. Example: [{ rules: [{ field: "email", operator:
            "endsWith", value: "@acme.com" }], role: "member", groups:
            ["engineering"] }]
          items:
            type: object
            required:
              - rules
            properties:
              rules:
                type: array
                description: Conditions that must ALL match (AND logic)
                items:
                  type: object
                  required:
                    - field
                    - operator
                    - value
                  properties:
                    field:
                      type: string
                      description: >-
                        User attribute to match, supports dot notation for
                        nested fields (e.g. "email", "authData.google.hd")
                    operator:
                      type: string
                      enum:
                        - equals
                        - startsWith
                        - endsWith
                        - matches
                      description: >-
                        Match operator. "matches" supports wildcard patterns
                        (e.g. "*@acme.com", "*" to match any value)
                    value:
                      type: string
                      description: Value to match against (case-insensitive)
              role:
                type: string
                description: Role slug to assign (defaults to org's defaultRole)
              groups:
                type: array
                description: Group slugs to add the user to
                items:
                  type: string
        defaultRole:
          type: string
        auth:
          type: object
          description: Organization-scoped authentication settings
          properties:
            anonymous:
              type: object
              description: >-
                Settings for anonymous sessions scoped to this organization.
                When enabled, callers of POST /v2/login/anonymous can pass this
                org's slug to receive a token bound to the configured role.
              required:
                - enabled
              properties:
                enabled:
                  type: boolean
                  description: Whether anonymous sessions are allowed for this org
                role:
                  type: string
                  description: >-
                    Org role slug (e.g. "org:member" or a custom role) applied
                    to anonymous sessions targeting this org. Required when
                    enabled is true. Owner/Admin and roles with wildcard
                    permissions are forbidden.
                allowedDomains:
                  type: array
                  description: >-
                    Origin hostnames allowed to create anonymous sessions for
                    this org. When non-empty, the gateway:
                      1. Auto-resolves orgSlug from the request's Origin/Referer when
                         the body field is omitted (single-org match per hostname).
                      2. Rejects /login/anonymous calls whose Origin host does not match
                         any entry — even when the body explicitly carries this orgSlug.
                    Each entry is a hostname (e.g. "chat.acme.com") or a
                    subdomain wildcard (e.g. "*.acme.com") with an optional
                    per-domain role override. When `role` is set, it takes
                    precedence over `auth.anonymous.role` for sessions opened
                    from that domain. When empty/undefined, any Origin is
                    accepted but auto-detection is disabled (the body must carry
                    orgSlug).
                  items:
                    type: object
                    required:
                      - domain
                    properties:
                      domain:
                        type: string
                        description: >-
                          Hostname (e.g. "chat.acme.com") or subdomain wildcard
                          ("*.acme.com")
                      role:
                        type: string
                        description: >-
                          Optional org role slug applied to anonymous sessions
                          opened from this specific domain. Falls back to the
                          top-level auth.anonymous.role when omitted. Same
                          Owner/Admin/wildcard restrictions apply.
        settings:
          type: object
          additionalProperties: true
        subscriptionSlug:
          type: string
        createdBy:
          type: string
        updatedBy:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
    AuthenticationError:
      type: object
      properties:
        error:
          type: string
          example: AuthenticationError
        message:
          type: string
          example: Unauthenticated
    Navigation:
      type: object
      description: Organization navigation configuration
      properties:
        version:
          type: integer
          description: Schema version number
        homePage:
          type: string
          description: >-
            Route to use as home page (e.g., "/apps/agent-factory"). Must be a
            valid relative path starting with /. If not set, defaults to the
            platform default (SecureChat).
          pattern: ^\/[a-zA-Z0-9\-_\/]*$
        menu:
          type: array
          description: Main menu items
          items:
            $ref: '#/components/schemas/NavigationItem'
        footer:
          type: array
          description: Footer menu items
          items:
            $ref: '#/components/schemas/NavigationItem'
        quickActions:
          type: array
          description: Quick action buttons
          items:
            $ref: '#/components/schemas/NavigationItem'
    NavigationItem:
      type: object
      description: Menu item in the navigation structure
      required:
        - id
        - type
      properties:
        id:
          type: string
          description: Unique identifier for this menu item
        type:
          type: string
          enum:
            - category
            - item
            - divider
        label:
          type: string
          description: Display label (not required for dividers)
        icon:
          type: string
          description: Icon name (from lucide-react)
        color:
          type: string
          description: Icon color (CSS color value)
        href:
          type: string
          description: Link destination (for type=item)
        target:
          type: string
          enum:
            - _self
            - _blank
          description: Link target
        expanded:
          type: boolean
          description: Whether category is expanded by default
        badge:
          type: string
          description: Badge text to show (e.g., "New", "Beta")
        permissions:
          type: array
          description: Permissions required to see this item
          items:
            type: string
        features:
          type: array
          description: Features attached to this item
          items:
            $ref: '#/components/schemas/NavigationFeature'
        visibility:
          type: object
          description: Visibility rules for subscription tiers/features
          properties:
            tiers:
              type: array
              items:
                type: string
            features:
              type: array
              items:
                type: string
        items:
          type: array
          description: Child items (for type=category)
          items:
            type: object
            description: >-
              Recursive reference to `NavigationItem` — nesting is truncated
              here to avoid the infinite expansion that crashes the API
              reference renderer.
      example:
        id: workspaces
        type: category
        label: Workspaces
        icon: folder
        expanded: true
        items:
          - id: workspaces-list
            type: item
            label: All workspaces
            href: /workspaces
          - id: workspaces-create
            type: item
            label: Create workspace
            href: /workspaces/new
    NavigationFeature:
      type: object
      description: Feature attached to a navigation item (agent or template)
      required:
        - type
        - slug
        - label
      properties:
        type:
          type: string
          enum:
            - agent
            - template
        slug:
          type: string
          description: Unique identifier for this feature within the menu item
        label:
          type: string
          description: Display label for the feature
        agentId:
          type: string
          description: Agent ID (required when type=agent)
        templateId:
          type: string
          description: Template ID (required when type=template)
        permissions:
          type: array
          description: Permissions required to see this feature
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OrgApiKeyAuth:
      type: apiKey
      in: header
      name: x-prismeai-api-key

````