Invites

List invites

GET/v1/workspaces/{workspaceId}/invites

The workspace's pending invites, newest first. A member limited to some brands doesn't manage invites, so for them the list is empty.

curl "$AYEFORM_API/v1/workspaces/$WORKSPACE_ID/invites" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

[
  {
    "id": "22aghnfgsyjq4xbbb57ke59djnbc9seg",
    "email": "orders@luigispizza.com",
    "acceptUrl": "https://luigispizza.com",
    "expiresAt": 1790879400000,
    "createdAt": 1790879400000,
    "invitedBy": {
      "kind": "user",
      "userId": "tjkfq4cpgb1c6746gmaw2gyd67qvn2hj"
    },
    "expired": false
  }
]

Path parameters

workspaceIdstringrequired
The workspace's id. An API key can only use its own workspace.

Response

A list of objects.

idstringrequired
emailstringrequired
The invited email address. Only this address can accept the invite.
acceptUrlstringrequired
The link in the invite email. Only the invited address can accept it.
expiresAtnumberrequired
When the link stops working, in milliseconds since the epoch.
createdAtnumberrequired
When the invite was sent, in milliseconds since the epoch.
invitedByone of 2required
Who sent the invite, a person or an API key.
Show 2 optionsHide 2 options
- kind: "user"
  - kind"user"required
  - userIdstringrequired
- kind: "apiKey"
  - kind"apiKey"required
  - apiKeyIdstringrequired
expiredbooleanrequired
True once expiresAt has passed and the link no longer works. Resending the invite sends a fresh one.

Errors answer with a status and the error shape.