---
title: "overlane operator invitations list"
description: "List who may create an account while Overlane is invite-only (Overlane staff)"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane operator invitations list

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Lists every invited email address and domain, with who added it and when, and says whether invite-only is on. Read-only. Only the Overlane staff team can call it.

## Usage

```sh
overlane operator invitations list [--service URL]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--service` | string | no |  | The service address (default: OVERLANE_SERVICE_URL, then the project's binding, then the hosted service) |

## Examples

```sh
overlane operator invitations list
overlane operator invitations list --json
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema operator invitations list`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "inviteOnly": {
      "type": "boolean"
    },
    "invitations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "pattern": {
            "type": "string",
            "maxLength": 254,
            "pattern": "^(?:@[a-z0-9-]+(?:\\.[a-z0-9-]+)+|[a-z0-9._%+-]+@[a-z0-9-]+(?:\\.[a-z0-9-]+)+)$"
          },
          "invitedBy": {
            "type": "string",
            "minLength": 1
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "emailed": {
            "type": "boolean"
          }
        },
        "required": [
          "pattern",
          "invitedBy",
          "createdAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "inviteOnly",
    "invitations"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/operator-invitations-list/index.mdx