GET /api/:space/member-messages/:id

Description:

Returns a member message for a specified space depending on the message id.

This assumes that messages have first been generated otherwise no data will be returned and the value of the "totalRecordsFound" variable in metadata will be 0.

GET responses can be filtered out based on the member-messages parameters to narrow down the results.

Resource URL:

https://<apphost>.competitionlabs.com/api/<your-space>/member-messages/<id>

Request header

Key	Value	Required
X-API-KEY		Yes
Content-Type	application/json	Yes

Request URL parameter

Parameter	Type	Required	Description
space	String	Yes	This is the space name which is linked to the account
id	String	Yes	Member message identifier retrieved from GET Member messages resource.

Example:

Request

curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space>/member-messages/GB-G33ABWweu1ZXez1LO

Response

{
	"meta": {
		"time": "2021-06-01T08:51:15.388Z",
		"totalRecordsFound": 1,
		"skip": 0,
		"limit": 20
	},
	"data": [{
		"jsonClass": "MemberMessage",
		"accountId": "TOQR32kB2TUmRj7Y-123",
		"memberId": "8W9033AByU-7qJmnbO4C",
		"eventRefType": "AchievementType",
		"eventReferenceId": "13U21HABb04K7-5xQMFl",
		"messageType": "Achievement",
		"subject": "test",
		"body": "",
		"status": "New",
		"created": "2020-03-15T18:48:39.118+0000",
		"metadata": [{
			"jsonClass": "Metadata",
			"key": "icon",
			"value": "6OwBqXABnvGGsQQTfHFp"
		}],
		"id": "GB-G33ABWweu1ZXez1LO"
	}]
}