> ## Documentation Index > Fetch the complete documentation index at: https://docs.effectiveai.app/llms.txt > Use this file to discover all available pages before exploring further. # List underwriting files > Underwriting files you can read, newest first, as summaries: manual, last seq and the offers' stages, without the view. Get one with `getUnderwritingFile` for its view. Filter by `manualId` or `stage` (an offer at that stage after the latest change); filters combine with AND. Pages can be short or empty before the end: pass `nextCursor` as `cursor` with the same filters and `limit` until it is null. Cursors do not expire. Read-only. ## OpenAPI ````yaml /openapi.json get /insurance/underwriting/files openapi: 3.0.3 info: title: Effective API version: 2.0.0 description: The public Effective REST API. Authenticate using an Effective API key. servers: - url: https://api.effectiveai.app/api/v2 description: Production security: - bearerAuth: [] paths: /insurance/underwriting/files: get: tags: - Underwriting workbench summary: List underwriting files description: >- Underwriting files you can read, newest first, as summaries: manual, last seq and the offers' stages, without the view. Get one with `getUnderwritingFile` for its view. Filter by `manualId` or `stage` (an offer at that stage after the latest change); filters combine with AND. Pages can be short or empty before the end: pass `nextCursor` as `cursor` with the same filters and `limit` until it is null. Cursors do not expire. Read-only. operationId: listUnderwritingFiles parameters: - schema: type: integer minimum: 1 maximum: 100 default: 50 description: Maximum number of items to return (1-100, default 50). required: false description: Maximum number of items to return (1-100, default 50). name: limit in: query - schema: type: string minLength: 1 maxLength: 8192 description: >- Opaque nextCursor from this operation. Repeat every other query parameter unchanged; a cursor from a different query returns invalid_cursor. required: false description: >- Opaque nextCursor from this operation. Repeat every other query parameter unchanged; a cursor from a different query returns invalid_cursor. name: cursor in: query - schema: type: string pattern: ^[a-f0-9]{64}$ description: Only underwriting files pinned to this manual. required: false description: Only underwriting files pinned to this manual. name: manualId in: query - schema: allOf: - $ref: '#/components/schemas/V2UnderwritingStage' - description: >- Only underwriting files with an offer at this stage after their latest change. required: false description: >- Only underwriting files with an offer at this stage after their latest change. name: stage in: query responses: '200': description: One page of underwriting files. content: application/json: schema: type: object properties: files: type: array items: $ref: '#/components/schemas/V2UnderwritingFile' nextCursor: type: string nullable: true description: Cursor for the next page, or null on the last page. required: - files - nextCursor additionalProperties: false '400': description: >- Invalid request, manual sources with errors, or rater bindings that do not match; `details` names each problem. Restart a list after `invalid_cursor`. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '403': description: >- `authority_required`: your role may not make this statement, another may. `underwriting_role_required`: you have no underwriting role. Or access is denied. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '404': description: Manual or underwriting file not found, or not visible to you. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '409': description: >- `stale_after`: the log moved past `after`; read the underwriting file and resend with `lastSeq`. `file_closed` or `wrong_stage`: the file or offer is not where the statement needs it. `offer_blocked`: something open (`blockers`) holds the offer a quote or bind is for. `rating_not_valid`: that offer has no valid rating of its current inputs (`rating` says why and how to recover). `target_stale`: the statement's `target` is not in the file's view for you now; read the file again. `idempotency_conflict`: the key was used with another request. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '413': description: Request body is too large. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '415': description: Content-Type must be application/json. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '422': description: >- `statement_rejected`: the manual cannot apply it (type, path or another rule); `no_route`: no one may do it. `target_wrong_kind`: that node does not take this statement; `target_wrong_scope`: the statement's path, choice, offer or package is not the node's. `statementIndex` (and `target`) say which. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' '503': description: >- `temporarily_unavailable`: the underwriting runtime is not configured on this server yet, or could not answer. Honor Retry-After. content: application/json: schema: $ref: '#/components/schemas/V2UnderwritingError' security: - bearerAuth: [] components: schemas: V2UnderwritingStage: type: string enum: - absent - not_offered - declined - gather - indicated - quotable - quoted - bound - withdrawn description: >- An offer's stage: `absent` or `not_offered` before it is offered, `declined` or `withdrawn` when out, else `gather`, `indicated`, `quotable`, `quoted`, `bound`. V2UnderwritingFile: type: object properties: id: type: string description: >- Stable underwriting file ID; also the ID of its underwriting submission record. title: type: string status: type: string enum: - draft - received - in_review - needs_information - accepted_for_quoting - declined - withdrawn description: The record status people set. agencyAccountId: type: string description: The agency account (the insured). Access follows it. productId: type: string nullable: true underwriterIds: type: array items: type: string description: Users assigned to underwrite it. manualId: type: string pattern: ^[a-f0-9]{64}$ description: The manual it is pinned to for good. lastSeq: type: integer description: >- Its last log entry, as of its latest change. Send the `lastSeq` of `getUnderwritingFile` as `after` with the next statements. stages: type: array items: $ref: '#/components/schemas/V2UnderwritingStage' description: The offers' stages after its latest change, in stage order. createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - title - status - agencyAccountId - productId - underwriterIds - manualId - lastSeq - stages - createdAt - updatedAt V2UnderwritingError: allOf: - $ref: '#/components/schemas/V2CodedError' - type: object properties: runtimeCode: type: string description: >- For underwriting refusals: the underwriting runtime’s own code, for diagnosis only. Act on `code`. statementIndex: type: integer nullable: true description: >- For underwriting refusals: the index of the statement it is about, when known. lastSeq: type: integer description: >- The underwriting file log’s last seq, for stale_after: send it as `after` after re-reading. target: type: string nullable: true description: >- The view node id a target_stale, target_wrong_kind or target_wrong_scope statement named. offer: type: string description: >- The offer a wrong_stage, offer_blocked or rating_not_valid quote or bind was for, when the server read it. blockers: type: array items: type: string description: >- For offer_blocked: the ids of the view nodes that hold the offer. rating: type: object properties: status: type: string description: >- The offer's rating status (`rating.status` of its view): `pending`, `stale`, `refused`, `unavailable`, or `incomplete` when inputs it needs are not accepted. runIds: type: array items: type: string description: The runs its outcomes are valued from. waitingOn: type: array items: type: string description: The paths the price waits on. recovery: type: string nullable: true description: What makes the rating valid again. required: - status - runIds - waitingOn - recovery description: >- For rating_not_valid: why the offer’s price is not usable, and how to recover. V2CodedError: allOf: - $ref: '#/components/schemas/V2Error' - type: object properties: code: type: string minLength: 1 description: Stable error code. Clients must tolerate unknown future codes. details: type: array items: type: object properties: location: type: string enum: - path - query - header - body path: type: array items: type: string maxLength: 64 maxItems: 12 code: type: string enum: - required - invalid_type - invalid_value - unknown_field message: type: string minLength: 1 maxLength: 200 required: - location - path - code - message minItems: 1 maxItems: 20 description: Bounded safe validation issues; may omit some invalid fields. requestId: type: string minLength: 1 maxLength: 128 description: >- Existing server correlation for this HTTP attempt, when available. dataset: type: string enum: - naic - osha description: Dataset needed for dataset_not_enabled. businessCode: type: string description: The rater’s own refusal code, for business_rejection. violations: type: array items: type: object properties: code: type: string description: Authored or built-in constraint code message: type: string description: Authored message for the failed constraint path: type: string description: Input path of the offending value; empty for the request value: nullable: true description: Offending input value, size-bounded by the runtime constraint: type: string description: The constraint the value failed, as text cite: type: string nullable: true description: >- Filing citation of the constraint, when the source cites one required: - code - message - path - value - constraint - cite additionalProperties: false maxItems: 256 description: >- Each input constraint the submission failed, for invalid_inputs and business_rejection. violationsTruncated: type: boolean description: >- True when the rater reported more violations than violations holds. executionId: type: string description: >- The recorded execution of a failed rating, for rater rating failures. accessUrl: type: string nullable: true format: uri description: Not currently returned. required: - code V2Error: type: object properties: error: type: string minLength: 1 description: Human-readable explanation of the failure. required: - error securitySchemes: bearerAuth: type: http scheme: bearer description: 'Effective API key. Send Authorization: Bearer sk-eai-...' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.