> ## Documentation Index > Fetch the complete documentation index at: https://docs.lighton.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get company details > This endpoint allows users to retrieve details of a specific company. Access levels: - SysAdmin/Account Manager: Can view any company - DPOAdmin: Read-only access to any company - Company Admin: Can view their own company - Company DPO: Read-only access to their own company - User: No access ## OpenAPI ````yaml /api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id} openapi: 3.1.0 info: title: LightOn API version: 3.15.0 (v3-instance) description: >- LightOn gives you an API to search, parse, and ingest documents at scale. Build knowledge-retrieval pipelines without managing vector databases or OCR models. servers: - url: https://paradigm.lighton.ai security: [] tags: - name: Models description: Operations about AI models - name: Workspaces description: Operations about workspaces - name: Users description: Operations about users - name: User Groups description: Operations about user groups - name: Companies description: Operations about companies paths: /api/v3/instance/companies/{id}: get: tags: - Companies summary: Get company details description: |- This endpoint allows users to retrieve details of a specific company. Access levels: - SysAdmin/Account Manager: Can view any company - DPOAdmin: Read-only access to any company - Company Admin: Can view their own company - Company DPO: Read-only access to their own company - User: No access operationId: api_v3_instance_companies_retrieve parameters: - in: path name: id schema: type: integer required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CompanyDetailResponse' description: Company details '403': content: application/json: schema: $ref: '#/components/schemas/APIV3ErrorResponse' examples: Forbidden: value: id: null code: 403 error: insufficient_permissions detail: You do not have permission to perform this action. doc_url: >- https://developers.lighton.ai/errors#insufficient_permissions description: Insufficient permissions '404': content: application/json: schema: $ref: '#/components/schemas/APIV3ErrorResponse' examples: NotFound: value: id: null code: 404 error: not_found detail: The requested resource was not found. doc_url: https://developers.lighton.ai/errors#not_found summary: Not Found description: The requested resource was not found '503': description: >- API is under maintenance. Check `GET /api/v3/system/status` for active periods and retry. content: application/json: schema: $ref: '#/components/schemas/ServiceMaintenance503' security: - bearerAuth: [] - {} components: schemas: CompanyDetailResponse: type: object description: Serializer for detailed company view properties: id: type: integer readOnly: true name: type: string description: The name of the company registered in the instance. maxLength: 255 dpo_email: type: - string - 'null' format: email description: Contact email displayed in user profiles for data privacy inquiries. maxLength: 254 max_users: type: integer maximum: 2147483647 minimum: -2147483648 description: Maximum allowed active users for this company license. allow_company_admins_to_manage_sso: type: boolean description: >- If the company admins of this company can create & manage their SSO configuration. auto_provision_external_users: type: boolean description: >- Automatically create user accounts when users log in via external auth (SSO/LDAP) for the first time. storage_limit_company_ws: type: - integer - 'null' maximum: 2147483647 minimum: -2147483648 description: >- Total storage ceiling for all workspace uploads combined (personal + all shared workspaces), in MB. Leave blank to use the default value. Use 0 to disable uploads. storage_limit_personal_ws: type: - integer - 'null' maximum: 2147483647 minimum: -2147483648 description: >- Limit for all combined personal workspaces in this company, in MB. Leave blank to use the default value. Use 0 to disable uploads. storage_limit_custom_ws: type: - integer - 'null' maximum: 2147483647 minimum: -2147483648 description: >- Limit for all combined shared workspaces in this company (including the company workspace), in MB. Leave blank to use the default value. Use 0 to disable uploads. created_at: type: string format: date-time readOnly: true login_method: allOf: - $ref: '#/components/schemas/LoginMethodEnum' description: |- Authentication method(s) allowed for users in this company. * `password` - Password * `sso` - Single Sign On * `ldap` - LDAP min_password_length: type: - integer - 'null' maximum: 32767 minimum: 0 description: >- Minimum password length for users in this company. Leave blank to use the platform default (8 characters). max_password_length: type: - integer - 'null' maximum: 32767 minimum: 0 description: >- Maximum password length for users in this company. Leave blank to use the platform default (128 characters). kg_tags_enabled: type: boolean description: >- Enable automatic document tagging using Knowledge Graph. Disabling this prevents token consumption for LLM-based tagging. Global setting must also be enabled. kg_summaries_enabled: type: boolean description: >- Enable automatic document summarization using Knowledge Graph. Disabling this prevents token consumption for LLM-based summaries. Global setting must also be enabled. kg_queries_enabled: type: boolean description: >- Enable automatic query suggestion generation using Knowledge Graph. Disabling this prevents token consumption for LLM-based query suggestions. Global setting must also be enabled. tier: allOf: - $ref: '#/components/schemas/TierEnum' description: >- Commercial tier for this company. Drives entitlements and billing posture. * `free` - Free * `pay-as-you-go` - Pay-as-you-go * `business` - Business is_telemetry_enabled: type: boolean title: Technical telemetry enabled description: >- If technical telemetry is enabled for this company. No user data is collected. is_telemetry_ids_allowed: type: boolean title: Technical telemetry IDs allowed description: >- Include company and user IDs in telemetry. Allows telemetry to be more useful for troubleshooting. required: - allow_company_admins_to_manage_sso - created_at - id - name APIV3ErrorResponse: type: object properties: id: type: - string - 'null' description: >- Job/resource id when one already exists (useful for async error diagnosis); null otherwise. code: type: integer description: HTTP status code error: type: string description: Error code used by the UI as a translation key detail: type: string description: Human-readable error message for developers doc_url: type: string description: Link to the error-code documentation page required: - code - detail - doc_url - error - id ServiceMaintenance503: type: object description: >- Returned by the maintenance middleware when the requested endpoint is blocked. required: - detail - error - mode properties: detail: type: string example: System is under maintenance. error: type: string example: service_maintenance mode: type: string enum: - full_shutdown - warning_banner description: >- `full_shutdown` blocks all traffic; `warning_banner` also blocks and shows a dismissible toast. reason: type: string description: Operator-supplied maintenance reason, if any. started_at: type: string format: date-time endpoint_category_names: type: array items: type: string description: >- Non-empty only for category-scoped periods. Empty means all endpoints are affected. LoginMethodEnum: enum: - password - sso - ldap type: string description: |- * `password` - Password * `sso` - Single Sign On * `ldap` - LDAP TierEnum: enum: - free - pay-as-you-go - business type: string description: |- * `free` - Free * `pay-as-you-go` - Pay-as-you-go * `business` - Business securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer authentication header of the form `Bearer `, where `` is your auth token. ````