> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # List or search mails > Returns mails for a tenant. Pass 'folder' to browse a folder or 'query' to full-text search. ## OpenAPI ````yaml /en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails openapi: 3.1.0 info: description: >- API for Lerian BC Correios, which connects the institution to BC Correio, Banco Central do Brasil's electronic correspondence system. It retrieves and stores the institution's BC Correio mail, sends messages to BACEN departments, and keeps an audit trail. title: Lerian BC Correios API version: 1.0.0 servers: - url: https://bc-correios.sandbox.lerian.net security: - BearerAuth: [] tags: - description: Mail listing, search, read, send, and lifecycle operations. name: Mails - description: Immutable audit-trail query and export. name: Audit - description: 'Per-tenant configuration: BCB credentials, polling, AI, retention.' name: Settings - description: Aggregate mail metrics and category breakdowns. name: Dashboard paths: /api/v1/correios/mails: get: tags: - Mails summary: List or search mails description: >- Returns mails for a tenant. Pass 'folder' to browse a folder or 'query' to full-text search. operationId: ListOrSearchMails parameters: - description: Folder filter (INBOX, SENT, ARCHIVED, CANCELLED) explode: false in: query name: folder schema: description: Folder filter (INBOX, SENT, ARCHIVED, CANCELLED) examples: - INBOX type: string - description: Full-text search keyword explode: false in: query name: query schema: description: Full-text search keyword type: string - description: Mail type filter (RESOLUTION, CIRCULAR, COMMUNICATION, OTHER) explode: false in: query name: type schema: description: Mail type filter (RESOLUTION, CIRCULAR, COMMUNICATION, OTHER) type: string - description: Read status filter (true=read, false=unread) explode: false in: query name: isRead schema: description: Read status filter (true=read, false=unread) type: string - description: Filter mails received after this date (ISO 8601) explode: false in: query name: receivedAfter schema: description: Filter mails received after this date (ISO 8601) type: string - description: Filter mails received before this date (ISO 8601) explode: false in: query name: receivedBefore schema: description: Filter mails received before this date (ISO 8601) type: string - description: AI analysis status filter (none, pending, completed, failed) explode: false in: query name: aiStatus schema: description: AI analysis status filter (none, pending, completed, failed) type: string - description: Pagination cursor (opaque) explode: false in: query name: cursor schema: description: Pagination cursor (opaque) type: string - description: Results per page (default 20, max 100) explode: false in: query name: limit schema: description: Results per page (default 20, max 100) type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MailListResponse' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '429': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Too Many Requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable security: - BearerAuth: [] components: schemas: MailListResponse: additionalProperties: false properties: hasMore: type: boolean items: items: $ref: '#/components/schemas/MailSummaryResponse' type: array nextCursor: type: - string - 'null' required: - items - nextCursor - hasMore type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. required: - correlationId type: object MailSummaryResponse: additionalProperties: false properties: destination: examples: - DEINF type: - string - 'null' folder: examples: - INBOX type: string hasAttachments: examples: - true type: boolean id: examples: - 550e8400-e29b-41d4-a716-446655440000 type: string isRead: examples: - false type: boolean receivedAt: examples: - '2026-03-28T10:30:00Z' type: string sendStatus: examples: - CONFIRMED type: - string - 'null' sender: examples: - BACEN/DENOR type: string subject: examples: - Comunicado BACEN - Resolução 4.966 type: string type: examples: - COMMUNICATION type: string required: - id - subject - sender - receivedAt - folder - type - hasAttachments - isRead - sendStatus - destination type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.