Skip to content
Shuffll Engage — API and...
/
/
Get invitation

Get invitation

Request

Read an invitation without sending mail.

Security
bearerAuth
Path
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
invitation_idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/engage/openapi/v1/organizations/{id}/invitations/{invitation_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Current resource or page.

Headers
X-Request-Idstring, (uuid)required

Identifier for tracing this response.

ETagstring

Quoted opaque revision when the resource or job result has one.

Bodyapplication/json
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
organization_idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
emailstringrequired
rolestringrequired
Enum:"org_admin""user"
statusstringrequired
Enum:"pending""accepted""revoked"
deliverystringrequired
Enum:"queued""sending""sent""failed""recovery_required"
expires_atstringrequired
revisionstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
Response
{
  "id": "string",
  "organization_id": "string",
  "email": "string",
  "role": "org_admin",
  "status": "pending",
  "delivery": "queued",
  "expires_at": "string",
  "revision": "string"
}