Skip to content

List activity stream for entity

GET
/api/activity-stream/{entityIdentifier}/list
curl --request GET \
--url https://api.wink.travel/api/activity-stream/f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92/list \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Retrieve a chronological list of activity events recorded against a given entity, filtered to the caller’s access level (EVERYONE, AUTHENTICATED, or ADMIN).

entityIdentifier
required
string
""

UUID of entity (booking, property, etc.) to retrieve stream for

Example
f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Activity stream entries successfully retrieved.

Media type application/json
object
id

Document UUID

string format: uuid
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
acl
required

Who can view this stream? Determines visibility level for activity entries.

string
""
Allowed values: EVERYONE AUTHENTICATED OWNER ADMIN
entityIdentifier
required

Unique identifier of the entity (booking, property, etc.) this activity is recorded against.

string format: uuid
"" >= 1 characters
emotion

Optional emotional sentiment or reaction emoji to accompany the activity (e.g., fire, heart, thumbs-up). Interpretation is client-side.

string
""
comment

Optional text comment from the user who created this activity. Used when manually recording events. Either comment or i18nKey must be provided.

string
""
i18nKey
required

Localized i18n message key to generate text on the front-end. Used for system-generated activities. Either comment or i18nKey must be provided.

string
"" >= 1 characters
attachmentId

Optional document attachment ID (e.g., Cloudinary asset ID) for files uploaded with the activity.

string
""
user

Optional user profile information of the person who created this activity, if available in the request context.

object
userIdentifier
required

User ID of authenticated person that created the stream.

string format: uuid
"" >= 1 characters
name
required

Full name of user.

string
"" >= 1 characters
profilePictureUrl

Optional URL of user’s profile picture.

string
""
key
additional properties
""
Example

Invalid entity identifier format.

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"properties": {
"additionalProperty": "example"
}
}

Caller is not authenticated.

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Entity not found or has no activity stream.

Media type application/json
Array<object>
object
id

Document UUID

string format: uuid
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
acl
required

Who can view this stream? Determines visibility level for activity entries.

string
""
Allowed values: EVERYONE AUTHENTICATED OWNER ADMIN
entityIdentifier
required

Unique identifier of the entity (booking, property, etc.) this activity is recorded against.

string format: uuid
"" >= 1 characters
emotion

Optional emotional sentiment or reaction emoji to accompany the activity (e.g., fire, heart, thumbs-up). Interpretation is client-side.

string
""
comment

Optional text comment from the user who created this activity. Used when manually recording events. Either comment or i18nKey must be provided.

string
""
i18nKey
required

Localized i18n message key to generate text on the front-end. Used for system-generated activities. Either comment or i18nKey must be provided.

string
"" >= 1 characters
attachmentId

Optional document attachment ID (e.g., Cloudinary asset ID) for files uploaded with the activity.

string
""
user

Optional user profile information of the person who created this activity, if available in the request context.

object
userIdentifier
required

User ID of authenticated person that created the stream.

string format: uuid
"" >= 1 characters
name
required

Full name of user.

string
"" >= 1 characters
profilePictureUrl

Optional URL of user’s profile picture.

string
""
Example
[
{
"id": "",
"createdDate": "",
"lastUpdate": "",
"version": "",
"acl": "EVERYONE",
"entityIdentifier": "",
"emotion": "",
"comment": "",
"i18nKey": "",
"attachmentId": "",
"user": ""
}
]

Internal Server Error

object
Example generated
{}