Sign in

v1

latestOpenAPI 3.0.3MIT2026-08-04143307364.8 KB
Organization API - Invitation

Create a new invitation

Create a new invitation.

post/v3/invitations

Request body

organizationstring required

Uniquely identify an organization.

emailstring required

The email which the invitation is sent to.

role'admin' | 'member' required

Example request

{
  "organization": "mEFayXdO",
  "email": "carljohnson@grove.street",
  "role": "admin"
}

Response

Returns the created invitation

identifierstring

Uniquely identify an invitation.

emailstring

The email which the invitation is sent to.

role'admin' | 'member'
status'pending' | 'accepted' | 'declined'
expiryDatestring date

The date after which the invitation expires. Default is 10 days from now.

createdDtstring date-time

Example response

{
  "identifier": "mEFayXdO",
  "organization": {
    "identifier": "mEFayXdO",
    "name": "Grove Street King",
    "userRole": "admin",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
    "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad"
  },
  "email": "carljohnson@grove.street",
  "role": "admin",
  "invitedBy": {
    "id": 1,
    "name": "Carl Johnson",
    "username": "carljohnson",
    "email": "carljohnson@grove.street",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
  },
  "respondedBy": {
    "id": 1,
    "name": "Carl Johnson",
    "username": "carljohnson",
    "email": "carljohnson@grove.street",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
  }
}