iam.invitations.list

List invitations

GET /iam/api/invitationsIAM iam:ListInvitationsRead

Request syntax

GET /iam/api/invitations

Query parameters

  • statusOptional

    enum

    Only invitations with this status; omitted: every invitation

    One of: pending, accepted, expired, cancelled

Response

200 with the invitations, newest first: id, email, role, status, expiresAt, createdAt, invitedBy, and expired (true once a pending link has run out).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow iam:ListInvitations on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud iam invitations list

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_invitations_list.