AFaffinda
Organization API - Invitation

Get list of all invitations

Changed on

Get list of all invitations you created or sent to you.

get/v3/invitations

Request

Query parameters

offsetinteger

The number of documents to skip before starting to collect the result set.

limitinteger
Example:20

The numbers of results to return.

organizationstring

Uniquely identify an organization.

Example:mEFayXdO

Filter by organization.

status'pending' | 'accepted' | 'declined'

Filter by status.

role'admin' | 'member'
Example:admin

Filter by role.

Response

All invitations you created or sent to you.

countinteger required

Number of items in results.

nextstring nullable

URL to request next page of results.

previousstring nullable

URL to request previous page of results.

Example response

{
  "count": 10,
  "results": [
    {
      "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"
      }
    }
  ]
}

Changes

  • 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

  • 978cf99a2ac0Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status