> ## Documentation Index > Fetch the complete documentation index at: https://docs.rangler.co/llms.txt > Use this file to discover all available pages before exploring further. # Get Connect Connection ## OpenAPI ````yaml /openapi.json get /v1/connect/connections/{connection_id} openapi: 3.1.0 info: title: Rangler API version: 1.0.0 description: >- Customer-facing Rangler API for companies, standardized financials, filings, funds, market data, events, and webhooks. servers: - url: https://api.rangler.co description: Live - url: https://sandbox-api.rangler.co description: Sandbox security: [] tags: - name: Analyst estimates description: Consensus forecasts, revisions, contributor accuracy, and source evidence. - name: Analyst recommendations description: Analyst ratings, target-price views, and company recommendation history. - name: Calendar description: Company events and calendar exports. - name: Companies description: >- Company lookup, issuer details, dividends, daily trades, meeting media, and mentions. - name: Events description: >- Read earlier events and check for missed deliveries across the market, a company, or a fund. - name: Financials description: >- Standardized financial statements, reported tables, ratios, and links to filing sources. - name: Filings description: Filings, board changes, insider dealings, and extracted filing mentions. - name: Funds description: Fund directories, disclosures, snapshots, holdings, and performance data. - name: Markets description: Market directories and regular-session clock data. - name: News description: Company news developments and company-filtered news search. paths: /v1/connect/connections/{connection_id}: get: tags: - Connect summary: Get Connect Connection operationId: get_v1_connect_connections_connection_id parameters: - name: connection_id in: path required: true schema: type: string format: uuid title: Connection Id - name: client_user_id in: query required: false schema: anyOf: - type: string maxLength: 160 minLength: 1 - type: 'null' title: Client User Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectConnectionDetail' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: default: value: error: type: unauthorized code: unauthorized message: Authentication required. request_id: 28fa6152-7081-492e-8a7e-00beb237b689 '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: default: value: error: type: forbidden code: forbidden message: Paid access is required. request_id: 5c253b3e-778e-4a58-aaf8-07cb21e03563 '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: default: value: error: type: not_found code: not_found message: Company not found request_id: 9f5237bc-7d8c-4a9d-9c1f-fbd4ef236cf9 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: default: value: error: type: validation_error code: validation_error message: Request validation failed request_id: c5964dca-d290-4465-a3dc-f92d42aa9b17 details: - type: missing loc: - query - ticker msg: Field required input: null '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: default: value: error: type: rate_limit_exceeded code: rate_limit_exceeded message: Rate limit exceeded request_id: cc4d369a-2c69-4ee2-909e-985ea35d14a9 '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: default: value: error: type: internal_server_error code: internal_server_error message: Internal Server Error request_id: 70b63aba-b8a3-41c2-bb0c-fbe67d84d37d security: - RanglerApiKey: [] components: schemas: ConnectConnectionDetail: properties: id: type: string format: uuid title: Id organization_id: type: string format: uuid title: Organization Id institution_id: type: string format: uuid title: Institution Id client_user_id: type: string title: Client User Id environment: $ref: '#/components/schemas/ConnectEnvironment' status: $ref: '#/components/schemas/ConnectConnectionStatus' consent_scopes: items: type: string type: array title: Consent Scopes last_synced_at: anyOf: - type: string format: date-time - type: 'null' title: Last Synced At revoked_at: anyOf: - type: string format: date-time - type: 'null' title: Revoked At created_at: type: string format: date-time title: Created At updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At institution: $ref: '#/components/schemas/ConnectInstitutionRead' latest_sync: anyOf: - $ref: '#/components/schemas/ConnectSyncRunRead' - type: 'null' type: object required: - id - organization_id - institution_id - client_user_id - environment - status - consent_scopes - created_at - institution title: ConnectConnectionDetail ErrorEnvelope: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorObject' ConnectEnvironment: type: string enum: - test - live title: ConnectEnvironment ConnectConnectionStatus: type: string enum: - active - login_required - revoked - error title: ConnectConnectionStatus ConnectInstitutionRead: properties: id: type: string format: uuid title: Id name: type: string title: Name auth_type: type: string title: Auth Type logo_url: anyOf: - type: string - type: 'null' title: Logo Url supports_accounts: type: boolean title: Supports Accounts supports_positions: type: boolean title: Supports Positions supports_transactions: type: boolean title: Supports Transactions credential_fields: items: $ref: '#/components/schemas/ConnectCredentialFieldRead' type: array title: Credential Fields type: object required: - id - name - auth_type - supports_accounts - supports_positions - supports_transactions title: ConnectInstitutionRead ConnectSyncRunRead: properties: id: type: string format: uuid title: Id connection_id: type: string format: uuid title: Connection Id status: $ref: '#/components/schemas/ConnectSyncRunStatus' trigger_source: type: string title: Trigger Source accounts_count: type: integer title: Accounts Count positions_count: type: integer title: Positions Count transactions_count: type: integer title: Transactions Count error_code: anyOf: - type: string - type: 'null' title: Error Code error_message: anyOf: - type: string - type: 'null' title: Error Message started_at: type: string format: date-time title: Started At completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At created_at: type: string format: date-time title: Created At type: object required: - id - connection_id - status - trigger_source - accounts_count - positions_count - transactions_count - started_at - created_at title: ConnectSyncRunRead ErrorObject: type: object required: - type - code - message - request_id properties: type: type: string code: type: string message: type: string request_id: type: string details: anyOf: - additionalProperties: true type: object - type: array items: additionalProperties: true type: object - type: 'null' ConnectCredentialFieldRead: properties: name: type: string enum: - username - password title: Name label: type: string title: Label input_type: type: string enum: - text - email - tel - password title: Input Type default: text autocomplete: anyOf: - type: string - type: 'null' title: Autocomplete placeholder: anyOf: - type: string - type: 'null' title: Placeholder type: object required: - name - label title: ConnectCredentialFieldRead ConnectSyncRunStatus: type: string enum: - pending - succeeded - failed title: ConnectSyncRunStatus securitySchemes: RanglerApiKey: type: apiKey in: header name: X-API-Key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.