---
updatedAt: 2026-08-26T10:06:08.000Z
agentTools:
  projectIndex: https://docs.allegrow.co/llms.txt
---

# List Users

Returns every user in your workspace — including invited users who have not yet signed up — with a summary of each user's connected mailboxes.

Users with no connected mailboxes appear with `mailboxes: []`, which makes this the endpoint for spotting who has not connected yet. Invited users have `status: invited`, carry `inviteExpiresAt` instead of `createdAt`, and always have an empty mailbox list.

Results are sorted by `email` ascending and paginate with `limit`/`offset`.


Returns every user in your workspace with a summary of each user's connected mailboxes.

* **Invited users are included**: anyone with a pending invitation appears with `status: invited`, an `inviteExpiresAt` timestamp instead of `createdAt`, an empty mailbox list, and `id: null` — their id is created when they sign up.
* **Zero-mailbox users are included**: an active user who hasn't connected anything appears with `mailboxes: []` — making this the endpoint for tracking who has and hasn't connected.

Each active user carries an `id` for [Get User](/reference/get-user). Use `?status=invited` for a pending-invites panel, or `?status=active` to exclude invites. The `mailboxes` array is a light summary (`email` + `connectionStatus`); for reputation and full mailbox detail, use [List Connected Mailboxes](/reference/list-connected-mailboxes). This endpoint carries no Safety Net data — that lives per mailbox on [List Safety Net Mailboxes](/reference/list-safety-net-mailboxes).

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Allegrow Workspace API",
    "description": "The Allegrow Workspace API provides read-only, programmatic access to your workspace's connected mailboxes, sender reputation, sending domains, Safety Net mailboxes, and users — the same data shown in the Allegrow app, ready to plug into your own dashboards and BI tooling.\n",
    "version": "1.0.0",
    "contact": {
      "name": "Allegrow Support",
      "email": "support@allegrow.co"
    }
  },
  "servers": [
    {
      "url": "https://api.allegrow.co",
      "description": "Production API"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/v1/users": {
      "get": {
        "summary": "List Users",
        "description": "Returns every user in your workspace — including invited users who have not yet signed up — with a summary of each user's connected mailboxes.\n\nUsers with no connected mailboxes appear with `mailboxes: []`, which makes this the endpoint for spotting who has not connected yet. Invited users have `status: invited`, carry `inviteExpiresAt` instead of `createdAt`, and always have an empty mailbox list.\n\nResults are sorted by `email` ascending and paginate with `limit`/`offset`.\n",
        "operationId": "listUsers",
        "tags": [
          "Users"
        ],
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "active",
                "invited"
              ]
            },
            "description": "Return only users in this state. Omit to return all. `total` reflects the filtered count.",
            "example": "invited"
          },
          {
            "$ref": "#/components/parameters/LimitParam"
          },
          {
            "$ref": "#/components/parameters/OffsetParam"
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of workspace users",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "limit",
                    "offset",
                    "total",
                    "users"
                  ],
                  "properties": {
                    "limit": {
                      "type": "integer",
                      "example": 50
                    },
                    "offset": {
                      "type": "integer",
                      "example": 0
                    },
                    "total": {
                      "type": "integer",
                      "description": "Total number of users (active + invited) across all pages.",
                      "example": 210
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/User"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid query parameter",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimpleError"
                },
                "example": {
                  "error": "limit must be an integer between 1 and 1000"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/MissingApiKeyError"
          },
          "403": {
            "$ref": "#/components/responses/InvalidApiKeyError"
          },
          "429": {
            "$ref": "#/components/responses/RateLimitError"
          },
          "503": {
            "description": "A dependent Allegrow service is temporarily unavailable. Retry after the number of seconds in the `Retry-After` header.",
            "headers": {
              "Retry-After": {
                "schema": {
                  "type": "integer"
                },
                "description": "Suggested seconds to wait before retrying."
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimpleError"
                },
                "example": {
                  "error": "Service temporarily unavailable"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key",
        "description": "Your Allegrow API key"
      }
    },
    "parameters": {
      "LimitParam": {
        "name": "limit",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000,
          "default": 50
        },
        "description": "Page size (1–1000). A single page can hold an entire workspace — for a full snapshot request limit=1000 rather than stitching offset pages, which are computed independently.",
        "example": 50
      },
      "OffsetParam": {
        "name": "offset",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 0,
          "default": 0
        },
        "description": "Zero-based index of the first entry to return.",
        "example": 0
      }
    },
    "responses": {
      "MissingApiKeyError": {
        "description": "Unauthorized - API key missing from the request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Unauthorized",
              "message": "Unauthorized",
              "statusCode": 401
            }
          }
        }
      },
      "InvalidApiKeyError": {
        "description": "Forbidden - API key invalid or inactive",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Forbidden",
              "message": "Forbidden",
              "statusCode": 403
            }
          }
        }
      },
      "RateLimitError": {
        "description": "Rate limit exceeded. Requests count against the same per-second rate limit as validation API calls.",
        "headers": {
          "Retry-After": {
            "description": "Suggested seconds to wait before retrying",
            "schema": {
              "type": "integer"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Too Many Requests",
              "message": "Too Many Requests",
              "statusCode": 429
            }
          }
        }
      }
    },
    "schemas": {
      "User": {
        "type": "object",
        "required": [
          "email",
          "firstName",
          "id",
          "lastName",
          "mailboxes",
          "role",
          "status"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "Opaque identifier for this user — use it with GET /v1/users/{id}. Always `null` for `invited` users; the id is created when they sign up.",
            "example": "550e8400-e29b-41d4-a716-446655440000"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the user signed up. Present on `active` users only.",
            "example": "2025-11-02T09:14:00Z"
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "rep@allegrow.co"
          },
          "firstName": {
            "type": "string",
            "nullable": true,
            "example": "Ada"
          },
          "inviteExpiresAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the pending invite expires. Present on `invited` users only.",
            "example": "2026-09-01T00:00:00Z"
          },
          "lastName": {
            "type": "string",
            "nullable": true,
            "example": "Lovelace"
          },
          "mailboxes": {
            "type": "array",
            "description": "The user's connected mailboxes, sorted by email ascending. Empty when the user has not connected any mailbox.",
            "items": {
              "type": "object",
              "required": [
                "connectionStatus",
                "email"
              ],
              "properties": {
                "connectionStatus": {
                  "type": "string",
                  "nullable": true,
                  "description": "Current connection state. Common values are `connected`, `disconnected`, and `credentials_error`.",
                  "example": "connected"
                },
                "email": {
                  "type": "string",
                  "format": "email",
                  "example": "rep@allegrow.co"
                }
              }
            }
          },
          "role": {
            "type": "string",
            "nullable": true,
            "description": "The user's role in the workspace.",
            "example": "member"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "invited"
            ],
            "description": "`active` users have signed up; `invited` users have a pending invitation.",
            "example": "active"
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "message",
          "error",
          "statusCode"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "error": {
            "type": "string",
            "description": "Error type"
          },
          "statusCode": {
            "type": "integer",
            "description": "HTTP status code"
          }
        }
      },
      "SimpleError": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "Error message"
          }
        }
      }
    }
  }
}
```