> ## Documentation Index > Fetch the complete documentation index at: https://docs.go.aiinsurance.io/llms.txt > Use this file to discover all available pages before exploring further. # Get Company Lifecycle > Returns company identity, mode, Owner and Purpose, caller-specific Reset eligibility and an unavailable reason, and the last successful Reset. Does not expose internal company notes, API-key secrets, or audit payloads. Lifecycle reads do not require a valid field configuration. Reset eligibility is advisory: the Reset operation checks permission and mode again. **Required permission:** `company.view` ## OpenAPI ````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/lifecycle openapi: 3.0.3 info: title: AI Insurance External API description: External API for AI Insurance platform version: 1.0.0 contact: email: support@aiinsurance.io servers: - url: https://go.aiinsurance.io description: Production security: - ApiKeyAuth: [] paths: /api/v1/companies/{companyId}/lifecycle: get: tags: - Companies summary: Get Company Lifecycle description: > Returns company identity, mode, Owner and Purpose, caller-specific Reset eligibility and an unavailable reason, and the last successful Reset. Does not expose internal company notes, API-key secrets, or audit payloads. Lifecycle reads do not require a valid field configuration. Reset eligibility is advisory: the Reset operation checks permission and mode again. **Required permission:** `company.view` operationId: getCompanyLifecycle parameters: - $ref: '#/components/parameters/companyId' responses: '200': description: Company lifecycle and caller Reset eligibility. content: application/json: schema: type: object required: - company - reset - lastReset properties: company: type: object required: - id - name - shortName - owner - purpose - mode - lifecycleVersion properties: id: type: string format: uuid name: type: string shortName: type: string owner: type: string nullable: true purpose: type: string nullable: true mode: type: string enum: - sandbox - live - retired lifecycleVersion: type: integer nullable: true reset: type: object required: - allowed - reason properties: allowed: type: boolean reason: type: string nullable: true lastReset: type: object nullable: true required: - timestamp - deletedRecords - resetCounters properties: timestamp: type: integer format: int64 description: Unix timestamp in milliseconds. deletedRecords: type: integer resetCounters: type: integer examples: permittedSandbox: summary: Sandbox with permission and no previous Reset value: company: id: 550e8400-e29b-41d4-a716-446655440000 name: Example Sandbox shortName: example-sandbox owner: Engineering purpose: Testing mode: sandbox lifecycleVersion: 1 reset: allowed: true reason: null lastReset: null readOnlySandbox: summary: Company read allowed but Reset denied value: company: id: 550e8400-e29b-41d4-a716-446655440000 name: Example Sandbox shortName: example-sandbox owner: Engineering purpose: Testing mode: sandbox lifecycleVersion: 1 reset: allowed: false reason: Reset requires the company.reset permission. lastReset: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' components: parameters: companyId: name: companyId in: path required: true schema: type: string format: uuid description: Company identifier responses: Unauthorized: description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingApiKey: summary: Missing API key value: error: code: AuthenticationError message: API key authentication required userMessages: - API key authentication required invalidApiKey: summary: >- Invalid API key (e.g. unknown key, or a Bearer token used instead of an API key) value: error: code: AuthenticationError message: Invalid API key userMessages: - Invalid API key Forbidden: description: Forbidden - Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: insufficientPermissions: summary: Insufficient permissions value: error: code: AuthorizationError message: User is not authorized to perform the requested action userMessages: - User is not authorized to perform the requested action companyMismatch: summary: A valid API key naming another company in the URL value: error: code: AuthorizationError message: API key is not scoped to the requested company userMessages: - API key is not scoped to the requested company InternalServerError: description: Internal Server Error - Unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internalError: summary: Unexpected server error value: error: code: UncaughtActionError message: Uncaught error occurred in userMessages: - An unexpected error occurred. Please try again later. schemas: ErrorResponse: type: object description: Standard error response for all external API endpoints required: - error properties: error: type: object required: - code - message properties: code: type: string description: Machine-readable error code example: VALIDATION_ERROR message: type: string description: Human-readable error message example: 'submissionId: Required field is missing' userMessages: type: array description: >- Clean, verbatim-displayable messages — one entry per failure, free of error-code tags, field paths, and internal noise. Suitable for showing to end users as-is. items: type: string example: - Exposures of type 'company' require an address details: type: array description: Additional details for validation errors (field-level errors) items: type: object properties: field: type: string description: The field that caused the error example: submissionId code: type: string description: Stable problem code for this individual validation failure example: BLANK_LIST_ELEMENT reason: type: string description: Stable reason the value violates its canonical contract example: blank-list-element expected: type: string description: The expected canonical value contract example: nonblank trimmed string message: type: string description: Description of the field error example: Required field is missing securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- API key authentication. Send your raw API key as the `Authorization` header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key` header; those are not accepted. ````