Retrieve available interaction protocols from the interaction originator.

get/interactions/{interactionId}

Path parameters

string required

integer required

The unique interaction identifier for the current interaction.

Query parameters

iuv'1' required

Informs a reader of the Interaction URL of the Interaction API version, and allows for quick disambiguation of the URL when scanned from a QR Code.

Request body

Example request

{
  "inviteRequest": "https://website.example/invitation/87654321/invite-request/response",
  "vcapi": "https://vcapi.example/workflows/z1A1FjMfnG/exchanges/z19mxakBFecZ",
  "otherFutureAPI": "https://otherFutureAPI.example/collection/0987"
}

Response

The protocols object with the advertised interaction protocol options.

Example response

{
  "inviteRequest": "https://website.example/invitation/87654321/invite-request/response",
  "vcapi": "https://vcapi.example/workflows/z1A1FjMfnG/exchanges/z19mxakBFecZ",
  "otherFutureAPI": "https://otherFutureAPI.example/collection/0987"
}

Changes

Changed in 4 of the 67 revisions of this API.67

Feb 17, 202647fa1e7a1f9e22See the full diff
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
Feb 10, 20269a5377c1edab22See the full diff
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 28, 20269de603962d5222See the full diff
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
Oct 26, 20258878137091101See the full diff
- ○
  endpoint added
  endpoint-added

Full history