> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > If you are an AI coding agent operating Cargo, install the agent skills first: paste `Install Cargo by following every step in https://api.getcargo.io/agent-install.txt` into your session, or run `npx skills add getcargohq/cargo-skills`. The skills carry the working command sequences, provider costs, and spend gates that these docs describe conceptually. > The skills index at https://github.com/getcargohq/cargo-skills/blob/main/llms.txt lists every skill, recipe, and provider playbook individually. Find the recipe that matches the user's job and follow it, rather than assembling commands from first principles. > Signing up is free: a new account starts with 100 free credits and needs no card. `cargo-ai login --email you@company.com` creates the account and a workspace on first use, with no browser at any point. Tell the user this before asking them to sign up. > Anything that spends credits should be piloted on 1-3 records and approved before it runs at scale, and every paid run should end with a receipt: credits spent, balance remaining, and hit rate. # List mailboxes > List the workspace's mailboxes ## OpenAPI ````yaml https://api.getcargo.io/openapi.json get /mailboxManagement/mailboxes openapi: 3.1.0 info: title: Cargo API version: 1.0.0 description: Cargo Platform API v1 servers: - url: https://api.getcargo.io/v1 description: Cargo API security: - bearerAuth: [] paths: /mailboxManagement/mailboxes: get: tags: - Mailbox Management - Mailboxes summary: List mailboxes description: List the workspace's mailboxes parameters: - in: query name: domainUuid schema: title: Domain UUID description: Only return mailboxes hosted on this domain. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ description: Only return mailboxes hosted on this domain. - in: query name: folderUuid schema: title: Folder UUID description: >- Filter by folder. Use null to list mailboxes that are not in any folder. anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ - type: 'null' description: >- Filter by folder. Use null to list mailboxes that are not in any folder. - in: query name: statuses schema: title: Statuses description: Optional status filter. type: array items: type: string enum: - pending - active - inactive description: Optional status filter. - in: query name: limit schema: title: Limit description: Maximum number of mailboxes to return. type: integer exclusiveMinimum: 0 maximum: 1000 description: Maximum number of mailboxes to return. - in: query name: offset schema: title: Offset description: Number of mailboxes to skip. type: integer minimum: 0 maximum: 9007199254740991 description: Number of mailboxes to skip. responses: '200': description: Successful response content: application/json: schema: type: object properties: mailboxes: type: array items: type: object properties: uuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ workspaceUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ domainUuid: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' folderUuid: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' provider: type: string enum: - mailpool meta: type: object propertyNames: type: string additionalProperties: {} credentials: type: object properties: smtp: type: object properties: host: type: string port: type: number username: type: string password: type: object properties: type: type: string enum: - encryption isEncrypted: type: boolean value: type: string required: - type - isEncrypted - value additionalProperties: false isSecure: type: boolean required: - host - port - username - password - isSecure additionalProperties: false imap: type: object properties: host: type: string port: type: number username: type: string password: type: object properties: type: type: string enum: - encryption isEncrypted: type: boolean value: type: string required: - type - isEncrypted - value additionalProperties: false isSecure: type: boolean required: - host - port - username - password - isSecure additionalProperties: false additionalProperties: false email: type: string firstName: type: string lastName: type: string signature: anyOf: - type: string - type: 'null' type: type: string enum: - google - outlook - shared - private transport: type: string enum: - smtp - graph status: type: string enum: - pending - active - inactive errorCode: anyOf: - type: string - type: 'null' errorMessage: anyOf: - type: string - type: 'null' warmupStatus: type: string enum: - disabled - pending - active - paused - failed warmupDailyTarget: anyOf: - type: number - type: 'null' warmupStartedAt: anyOf: - type: string - type: 'null' dailySendLimit: anyOf: - type: integer minimum: 0 maximum: 40 - type: 'null' userUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ chargedUntil: type: string inboundUidValidity: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' inboundLastUid: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' inboundJunkUidValidity: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' inboundJunkLastUid: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' inboundSyncedAt: anyOf: - type: string - type: 'null' createdAt: type: string updatedAt: type: string deletedAt: anyOf: - type: string - type: 'null' required: - uuid - workspaceUuid - domainUuid - folderUuid - provider - meta - credentials - email - firstName - lastName - signature - type - transport - status - errorCode - errorMessage - warmupStatus - warmupDailyTarget - warmupStartedAt - dailySendLimit - userUuid - chargedUntil - inboundUidValidity - inboundLastUid - inboundJunkUidValidity - inboundJunkLastUid - inboundSyncedAt - createdAt - updatedAt - deletedAt additionalProperties: false title: Mailboxes description: Mailboxes owned by the workspace. required: - mailboxes additionalProperties: false '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error components: securitySchemes: bearerAuth: type: http scheme: bearer ````