Get company details
curl --request GET \
--url https://paradigm.lighton.ai/api/v3/instance/companies/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/instance/companies/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://paradigm.lighton.ai/api/v3/instance/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 123,
"name": "<string>",
"allow_company_admins_to_manage_sso": true,
"created_at": "2023-11-07T05:31:56Z",
"dpo_email": "jsmith@example.com",
"max_users": -1,
"auto_provision_external_users": true,
"storage_limit_company_ws": -1,
"storage_limit_personal_ws": -1,
"storage_limit_custom_ws": -1,
"login_method": "password",
"min_password_length": 16383,
"max_password_length": 16383,
"kg_tags_enabled": true,
"kg_summaries_enabled": true,
"kg_queries_enabled": true,
"tier": "free",
"is_telemetry_enabled": true,
"is_telemetry_ids_allowed": true
}{
"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"
}{
"id": null,
"code": 404,
"error": "not_found",
"detail": "The requested resource was not found.",
"doc_url": "https://developers.lighton.ai/errors#not_found"
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Companies
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
GET
/
api
/
v3
/
instance
/
companies
/
{id}
Get company details
curl --request GET \
--url https://paradigm.lighton.ai/api/v3/instance/companies/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/instance/companies/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://paradigm.lighton.ai/api/v3/instance/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 123,
"name": "<string>",
"allow_company_admins_to_manage_sso": true,
"created_at": "2023-11-07T05:31:56Z",
"dpo_email": "jsmith@example.com",
"max_users": -1,
"auto_provision_external_users": true,
"storage_limit_company_ws": -1,
"storage_limit_personal_ws": -1,
"storage_limit_custom_ws": -1,
"login_method": "password",
"min_password_length": 16383,
"max_password_length": 16383,
"kg_tags_enabled": true,
"kg_summaries_enabled": true,
"kg_queries_enabled": true,
"tier": "free",
"is_telemetry_enabled": true,
"is_telemetry_ids_allowed": true
}{
"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"
}{
"id": null,
"code": 404,
"error": "not_found",
"detail": "The requested resource was not found.",
"doc_url": "https://developers.lighton.ai/errors#not_found"
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Authorizations
Response
Company details
Serializer for detailed company view