invite_list

List all invite codes, including ones that have expired or been used up.

Request

{ "cmd": "invite_list" }

No fields besides cmd.

Response

{
  "cmd": "invite_list",
  "invites": [
    {
      "code": "3F9A1C7E52B4",
      "max_uses": 5,
      "uses": 1,
      "created_by": "USR:local_bob",
      "created_at": 1767225600.123,
      "expires_at": 1767830400.123
    },
    {
      "code": "A07E6D21C9F3",
      "max_uses": 0,
      "uses": 14,
      "created_by": "USR:local_bob",
      "created_at": 1766620800.5,
      "expires_at": null
    }
  ]
}

Invites are in the order they were created. The server doesn’t mark which invites are usable. An invite is usable while expires_at is null or in the future, and max_uses is 0 or greater than uses.

Permissions

Requires manage_access. create_invite alone isn’t enough.

Errors

This command has no errors of its own.

See also