Get User Invitation REST Endpoint

GET api.ashx/v2/users/{userid}/invitations/{invitationkey}.{json|xml}

GET a user invitation by userid.

Scopes

Users › Read Invitations users.invitations.readonly

Request Parameters

Name	Type	Description	Required
InvitationKey	string	Invitation Key	Required
UserId	int?	UserId or Username are required.	Optional
Username	string	UserId or Username are required.	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/{userid}/invitations/{invitationkey}.json',
	data: { 
		'userid': '6',
		'invitationkey': 'invitationkey'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "UserInvitation": {
    "UserId": 6,
    "GroupId": 25,
    "GroupMembershipType": "groupmembershiptype",
    "Email": "email",
    "Message": "message",
    "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e"
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <UserInvitation>
    <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
    <UserId>6</UserId>
    <GroupId>25</GroupId>
    <GroupMembershipType>groupmembershiptype</GroupMembershipType>
    <Email>email</Email>
    <Message>message</Message>
  </UserInvitation>
</Response>

GET api.ashx/v2/users/{username}/invitations/{invitationkey}.{json|xml}

GET a user invitation by username.

Scopes

Users › Read Invitations users.invitations.readonly

Request Parameters

Name	Type	Description	Required
InvitationKey	string	Invitation Key	Required
UserId	int?	UserId or Username are required.	Optional
Username	string	UserId or Username are required.	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/{username}/invitations/{invitationkey}.json',
	data: { 
		'username': 'username',
		'invitationkey': 'invitationkey'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "UserInvitation": {
    "UserId": 6,
    "GroupId": 25,
    "GroupMembershipType": "groupmembershiptype",
    "Email": "email",
    "Message": "message",
    "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e"
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <UserInvitation>
    <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
    <UserId>6</UserId>
    <GroupId>25</GroupId>
    <GroupMembershipType>groupmembershiptype</GroupMembershipType>
    <Email>email</Email>
    <Message>message</Message>
  </UserInvitation>
</Response>

Recommended