v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Invites

List Wallet Invites

This API method allows the calling application to retrieve all invites using either the GUID or reference (or both).

get/wallet/invites

Query parameters

guidstring string

Wallet Invitation GUID

referencestring string

Wallet Invitation Reference

walletIdstring string

Query string for Result filtering by Wallet Id

state[]string string

Query string for Result filtering by Invite State(s). For single filtering value square brackets could be omitted.

status[]string string

Query string for Result filtering by Invite Status(es). For single filtering value square brackets could be omitted.

type[]string string

Query string for Result filtering by Invite Type(s). For single filtering value square brackets could be omitted.

unitId[]string string

Query string for Result filtering by supplied Unit.

dateCreatedstring

Query string for Result filtering by date created

lastUpdatedstring

Query string for Result filtering by date last updated

validFromstring

Query string for Result filtering by valid from date

validTostring

Query string for Result filtering by valid to date

limitinteger

Query string Pagination Limit

offsetinteger

Query string Pagination Offset

Response

OK

limitinteger

Results per page

totalinteger

Total Results

offsetinteger

Offset

Example response

{
  "results": [
    {
      "validFrom": "2017-01-17T13:20:48+00:00",
      "validTo": "2017-01-17T13:20:48+00:00",
      "dateCreated": "2017-01-17T13:20:48+00:00",
      "lastUpdated": "2017-01-17T13:20:48+00:00"
    }
  ]
}