---
updatedAt: 2026-05-28T13:22:33.000Z
agentTools:
  projectIndex: https://api.help.mabl.com/llms.txt
---

# Get information on Mailboxes by workspace ID

Get permanent email addresses in workspace and number of remaining allowed permanent Mailboxes for workspace

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "mabl API",
    "description": "APIs for interacting with mabl services",
    "version": "0.563.3-2026-10-09.1791576280-jbaldassari-1791576682-SNAPSHOT"
  },
  "servers": [
    {
      "url": "https://api.mabl.com/"
    }
  ],
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "bearerAuth": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "Mailbox": {
        "type": "object",
        "properties": {
          "workspace_id": {
            "type": "string"
          },
          "created_time": {
            "type": "integer",
            "format": "int64",
            "description": "Time Mailbox was created"
          },
          "email_address": {
            "type": "string",
            "description": "Email address to be used in Mailbox steps"
          },
          "last_updated_time": {
            "type": "integer",
            "format": "int64",
            "description": "Time Mailbox was last updated"
          },
          "disabled_time": {
            "type": "integer",
            "format": "int64",
            "description": "Time Mailbox was disabled. If null, the Mailbox is enabled."
          },
          "name": {
            "type": "string",
            "description": "Email address name (permanent emails only)"
          },
          "last_updated_by_id": {
            "type": "string",
            "description": "ID of user who last updated Mailbox"
          },
          "description": {
            "type": "string",
            "description": "Email address description (permanent emails only)"
          },
          "id": {
            "type": "string"
          },
          "created_by_id": {
            "type": "string",
            "description": "ID of user who created Mailbox"
          }
        }
      },
      "ErrorResponseGeneric": {
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32",
            "minimum": 100,
            "maximum": 599
          },
          "id": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "MailboxesInWorkspaceResponse": {
        "description": "Contains permanent Mailbox addresses in workspace and the remaining number of Mailboxes allowed",
        "type": "object",
        "properties": {
          "remaining_allowed_mailboxes": {
            "type": "integer",
            "description": "Remaining number of permanent Mailboxes that the workspace is allowed to create",
            "readOnly": true
          },
          "mailboxes": {
            "type": "array",
            "description": "All permanent Mailboxes in workspace",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/Mailbox"
            }
          }
        }
      }
    },
    "responses": {
      "ErrorResponse": {
        "description": "Unknown error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponseGeneric"
            }
          }
        }
      },
      "ErrorResponse401": {
        "description": "User not authenticated",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponseGeneric"
            }
          }
        }
      },
      "ErrorResponse403": {
        "description": "User not authorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponseGeneric"
            }
          }
        }
      },
      "ErrorResponse400": {
        "description": "Invalid or missing parameter",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponseGeneric"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/mailbox/address/workspace/{workspace_id}": {
      "get": {
        "summary": "Get information on Mailboxes by workspace ID",
        "operationId": "queryMailboxesInWorkspace",
        "description": "Get permanent email addresses in workspace and number of remaining allowed permanent Mailboxes for workspace",
        "responses": {
          "200": {
            "description": "Information about permanent Mailboxes in this workspace",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailboxesInWorkspaceResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/ErrorResponse400"
          },
          "401": {
            "$ref": "#/components/responses/ErrorResponse401"
          },
          "403": {
            "$ref": "#/components/responses/ErrorResponse403"
          },
          "404": {
            "description": "No workspace matching this ID could be found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseGeneric"
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/ErrorResponse"
          }
        },
        "parameters": [
          {
            "schema": {
              "type": "string"
            },
            "in": "path",
            "name": "workspace_id",
            "required": true
          }
        ],
        "tags": [
          "Mailbox"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "Mailbox"
    }
  ]
}
```