get_watches_by_owner
Get all watches (pins and subscriptions) for an entity.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ownerId | string | Yes | The entity ID to get watches for (e.g. item ID). |
Returns
A list ofWatchDto objects, each containing:
watchId— unique watch identifierownerId— the entity being watchedwatcherId— the watcher (user, email, or user group)type— watch type (PinorFollower)watcherType— watcher entity type
get_watches_by_watcher
Get all watches created by a specific watcher.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
watcherId | string | Yes | The watcher ID (user, email, or user group). |
Returns
A list ofWatchDto objects.
get_watch
Get a single watch by its ID.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
watchId | string | Yes | The watch ID. |
Returns
AWatchDto with watch details.
create_watch
Create a new watch (pin or subscription) on an entity.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ownerId | string | Yes | The entity to watch (e.g. item ID). |
watcherId | string | Yes | The watcher (user ID). Use get_user_list. |
type | string | No | Watch type: Pin (default) or Follower. |
Returns
The createdWatchDto.
update_watch
Update a watch’s type.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
watchId | string | Yes | The watch ID. Use get_watches_by_owner or get_watches_by_watcher. |
type | string | No | New watch type: Pin or Follower. |
Returns
The updatedWatchDto.
delete_watch
Delete a watch by its ID.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
watchId | string | Yes | The watch ID. Use get_watches_by_owner or get_watches_by_watcher. |