AFaffinda
Organization API - Invitation

Get detail of an invitation by token

Changed on

Get detail of an invitation using a secret token. This allows users who have not registered/logged in to view the invitation.

get/v3/invitations/token/{token}

Request

Path parameters

tokenstring required

Invitation token.

Response

Successfully retrieved 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"
  },
  "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"
  }
}

Changes

  • a180d9191a03Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

  • acca5642c0bcRevision changes
    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status