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

# Get v2orgs

> Get an organization by slug



## OpenAPI

````yaml /api-reference/swagger.yml get /v2/orgs/{orgSlug}
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.eda.prisme.ai
  - url: http://localhost:3001
security:
  - BearerAuth: []
  - WorkspaceApiKeyAuth: []
  - BearerAuth: []
    WorkspaceApiKeyAuth: []
paths:
  /v2/orgs/{orgSlug}:
    get:
      tags:
        - Organizations
      description: Get an organization by slug
      operationId: getOrganization
      parameters:
        - name: orgSlug
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: AuthenticationError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectNotFoundError'
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
                      description: Match operator
                    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
        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
    ObjectNotFoundError:
      type: object
      properties:
        error:
          type: string
          example: ObjectNotFound
        message:
          type: string
    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:
            $ref: '#/components/schemas/NavigationItem'
    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
    WorkspaceApiKeyAuth:
      type: apiKey
      in: header
      name: x-prismeai-api-key

````