---
title: "Connect a Google Workspace"
method: POST
path: "/api/v1/inboxes/google-workspace"
tags: ["Mailboxes"]
---

# Connect a Google Workspace

`POST /api/v1/inboxes/google-workspace`

## Request

- Base URL: `https://app.argorant.com`
- URL: `https://app.argorant.com/api/v1/inboxes/google-workspace`
- Auth: HTTP bearer

Two calls. Without `emails` you get what the Workspace admin must add in Google Admin (a client id and its access list) and, once that is done, every mailbox and alias in the Workspace. With `emails` those addresses are connected as senders. No passwords and no sign-in per mailbox.

| Cost | What it does | Key scopes |
| --- | --- | --- |
| Free | Writes | `argorant:manage_lists` |

## Headers

- `Idempotency-Key` string
- `X-Request-Id` string

## Request body

- object
  - `admin_email` string, email, required: A Workspace admin address.
  - `emails` string[]: Mailboxes to connect. Leave out to only list them.

## Response `200`

Listing or Connected

- object
  - `setup` object
    - `client_id` string
    - `scopes_csv` string
  - `domains` string[]
  - `mailboxes` object[]
    - `email` string
    - `name` string
    - `connected` boolean
    - `alias` boolean

## Other responses

- `401`: 401 Unauthorized. `unauthorized` when the API key is missing, wrong or revoked.
- `403`: 403 Forbidden. `scope_missing` when the key lacks argorant:manage_lists.
- `409`: 409 Conflict. `idempotency_conflict` when the Idempotency-Key was used with another body.
- `422`: 422 Validation error. `validation_error` when a field has the wrong type or is missing.
- `429`: 429 Too many requests. `rate_limited` when too many requests this minute.

---

[API](https://skmtc.dev/argorant/apis/argorant-api.md) · [All operations](https://skmtc.dev/argorant/apis/argorant-api/llms.txt) · [OpenAPI document](https://skmtc.dev/argorant/apis/argorant-api/revisions/4bc28c0085b6?raw)