Skip to the documentation
API

List pending invitations

The invitations nobody has accepted yet, by email.

GETapi.openemail.uk/members/invitations

Runs the real call against your workspace, with your own key.

GET /members/invitations

The invitations nobody has accepted yet, by email.

Example

Needs members:read. Each one carries the role and the addresses and whole domains it grants once accepted, when it expires, and whether the last email reached them. Paged like every other list: limit and cursor in, hasMore and nextCursor out.

curl
curl "$OE/members/invitations" -H "$AUTH"
Response
{  "object": "list",  "data": [{      "object": "invitation",      "id": "winv_6bb640f5b99e47deb758f1f5",      "email": "[email protected]",      "role": {        "id": "role_2b81de079c1f0a4b7e05d386",        "name": "Support",        "builtin": null      },      "addresses": [],      "domains": [        {          "domainId": "93542ff8-2baa-4f2f-841d-5ceaa074ab0d",          "domain": "acme.com",          "access": "member"        }      ],      "expiresAt": "2026-10-07T09:12:40.000Z",      "expired": false,      "lastSentAt": "2026-09-23T09:12:40.000Z",      "delivered": true,      "deliveryError": null,      "createdAt": "2026-09-18T14:07:31.000Z"    }],  "hasMore": false,  "nextCursor": null}

A waiting invitation grants nothing. An expired one stays on this list with expired: true until it is sent again, which renews it, or withdrawn.

delivered is false when the email did not leave the mail server, with the reason in deliveryError, and null when no outcome was recorded for the last send.

A key limited to particular addresses or domains lists only the invitations that grant nothing outside them.