Skip to main content
GET
/
api
/
agency-portal
/
Invitations
/
{linkingCode}
Get an Invitation by Linking Code.
curl --request GET \
  --url https://api.example.com/api/agency-portal/Invitations/{linkingCode}
[
  {
    "id": 123,
    "customerName": "<string>",
    "createdById": 123,
    "createdByUserName": "<string>",
    "linkingCode": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "expiryDate": "2023-11-07T05:31:56Z",
    "nickName": "<string>",
    "firstName": "<string>",
    "emailAddress": "<string>"
  }
]

Path Parameters

linkingCode
string
required

Response

200 - application/json

OK

id
integer<int32>
customerName
string | null
createdById
integer<int32>
createdByUserName
string | null
linkingCode
string | null
createdDate
string<date-time>
expiryDate
string<date-time>
nickName
string | null
firstName
string | null
emailAddress
string | null