> ## Documentation Index > Fetch the complete documentation index at: https://docs.findable.net/llms.txt > Use this file to discover all available pages before exploring further. # Get connections by platform type ## OpenAPI ````yaml /api-reference/openapi.json get /dataplatform/connections/type/{type} openapi: 3.0.3 info: title: Findable API version: 3.2.38 description: > REST API for the Findable AI Assistant platform. ## Authentication All endpoints (except `/server/setup` and `/server/bootstrap`) require a valid **Azure AD / Entra ID Bearer token**. ### Obtaining a token 1. Register (or reuse) an **App Registration** in Azure Entra ID for your client. 2. Under **API Permissions**, add a delegated permission for the Findable server app: `api:///User.Read` 3. Acquire a token using MSAL (or any OAuth 2.0 library) with the following parameters: | Parameter | Value | |-----------|-------| | Authority | `https://login.microsoftonline.com/` | | Client ID | Your client app registration ID | | Scope | `api:///User.Read` | | Grant type | Authorization Code (interactive) or Client Credentials (daemon) | ### Example (MSAL Node.js) ```javascript const { ConfidentialClientApplication } = require("@azure/msal-node"); const cca = new ConfidentialClientApplication({ auth: { clientId: "", authority: "https://login.microsoftonline.com/", clientSecret: "", }, }); const result = await cca.acquireTokenByClientCredential({ scopes: ["api:///.default"], }); // Use result.accessToken in the Authorization header ``` ### Using the token Include the token in every request: ``` Authorization: Bearer ``` ### Roles Access is determined by Azure AD group membership configured in the application settings: - **Admin (Owner)**: Full access to all endpoints including admin operations - **Contributor**: Can create and manage chats, files, and content - **User**: Read access to entitled chats and resources contact: name: Findable Support license: name: Proprietary servers: - url: /server description: Application server (relative) security: - BearerAuth: [] tags: - name: AI description: Chat completion and AI generation endpoints - name: Chats description: Chat configuration CRUD with ACL enforcement - name: Settings description: Application settings and health - name: Files description: Blob storage file operations - name: Search description: Azure AI Search resource management - name: User description: User profile, feedback, chat logs, and preferences - name: Flows description: FlowEngine flow designer operations - name: Prompts description: Prompt template management - name: Pages description: Navigation page management - name: Admin description: Administrative operations (admin-only) - name: Bootstrap description: Bootstrap seed data operations (admin-only) - name: Setup description: Initial application setup (pre-auth) - name: Cosmos description: Generic Cosmos DB CRUD operations - name: Tools description: Tool providers, web search, and utility tools - name: MCP description: Model Context Protocol server management - name: Telemetry description: Version, health, and API permission checks - name: SharePoint description: SharePoint entitlement management - name: Data Platform description: Data platform connection management - name: Vector Stores description: Vector store provider operations - name: OneDrive description: OneDrive personal file storage operations - name: Jobs description: Background job and scheduler management - name: Memory description: User and organizational memory operations - name: Slack description: >- Slack bot interactions and webhooks (public, uses Slack signature verification) - name: Teams description: Microsoft Teams bot webhooks and interactions - name: Human Input description: Human-in-the-loop input requests for flow executions - name: Datasources description: Datasource catalog CRUD with ACL enforcement - name: Assignments description: >- Assignment lifecycle: inbox, sent, create, launch, complete, delegate, reject, reassign, remind, and recurring schedules. Experimental feature — requires experimental flag enabled. paths: /dataplatform/connections/type/{type}: get: tags: - Data Platform summary: Get connections by platform type parameters: - in: path name: type required: true schema: type: string responses: '200': description: Array of connections of the specified type content: application/json: schema: type: array items: $ref: '#/components/schemas/DataConnection' components: schemas: DataConnection: type: object properties: id: type: string name: type: string description: type: string type: description: DataPlatformType — database or vector store engine type: string enum: - mssql - postgres - mysql - mariadb - oracle - db2 - sqlite - supabase - hana - duckdb - databricks - snowflake - redshift - synapse - fabric-warehouse - fabric-lakehouse - athena - bigquery - clickhouse - trino - adx - cosmosdb - mongodb - dynamodb - cassandra - couchdb - firebase - pinecone - weaviate - qdrant - chroma - elasticsearch - opensearch - pgvector - redis - milvus - mongodb_atlas - vertex_ai_search - aws_kendra - oracle_vector - vespa - lancedb - marqo scope: type: string enum: - personal - shared isPublic: type: boolean owners: type: array items: type: object properties: id: type: string minLength: 1 type: type: string enum: - group - user displayName: type: string mail: type: string securityEnabled: type: boolean mailEnabled: type: boolean groupTypes: nullable: true type: array items: type: string groupType: type: string userPrincipalName: type: string jobTitle: type: string department: type: string officeLocation: type: string required: - id - type additionalProperties: {} contributors: type: array items: type: object properties: id: type: string minLength: 1 type: type: string enum: - group - user displayName: type: string mail: type: string securityEnabled: type: boolean mailEnabled: type: boolean groupTypes: nullable: true type: array items: type: string groupType: type: string userPrincipalName: type: string jobTitle: type: string department: type: string officeLocation: type: string required: - id - type additionalProperties: {} users: type: array items: type: object properties: id: type: string minLength: 1 type: type: string enum: - group - user displayName: type: string mail: type: string securityEnabled: type: boolean mailEnabled: type: boolean groupTypes: nullable: true type: array items: type: string groupType: type: string userPrincipalName: type: string jobTitle: type: string department: type: string officeLocation: type: string required: - id - type additionalProperties: {} inheritEntitlements: anyOf: - type: boolean - type: object properties: owners: type: boolean contributors: type: boolean users: type: boolean additionalProperties: false endpoint: description: Hostname, URL, or workspace URL type: string port: type: integer database: description: Database / catalog / project name type: string cloudProvider: type: string enum: - aws - azure - gcp region: description: AWS/Azure/GCP region type: string workspace: description: Databricks workspace ID type: string warehouse: description: Snowflake warehouse / Databricks SQL warehouse type: string httpPath: description: Databricks HTTP path type: string catalog: description: Unity Catalog / BigQuery dataset type: string schema: description: Default schema type: string s3OutputLocation: description: Athena results S3 location type: string authentication: type: object properties: type: type: string enum: - username-password - managed-identity - oauth - personal-access-token - api-key - service-principal - none username: type: string password: description: Redacted in responses type: string token: description: PAT or bearer token (redacted) type: string apiKey: description: API key (redacted) type: string clientId: type: string clientSecret: description: Redacted type: string tenantId: type: string additionalProperties: false index: description: Index / collection / class name for vector stores type: string namespace: description: Namespace / partition (Pinecone namespace, Redis prefix) type: string ssl: type: boolean verifySSL: description: 'Verify SSL certificates (default: true)' type: boolean timeout: description: Connection timeout in milliseconds type: integer maxRetries: type: integer connectionString: description: Full connection string (alternative to individual fields) type: string isEnabled: type: boolean createdBy: type: string createdAt: type: string updatedAt: type: string tags: type: array items: type: string required: - id additionalProperties: false title: DataConnection description: >- Unified data platform connection configuration (databases + vector stores) securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: Azure AD access token obtained via MSAL ````