TIC
Sign in to Lens

WatchList

Check watchlist memberships for an entity

Returns every watchlist the given entity belongs to. Specify exactly one of companyId, personId, addressId, propertyId, or vehicleId. Useful for UI badges showing 'this record is on N watchlists'.

Pro+ tier
GEThttps://lens-api.tic.io/watchlists/membership

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Query parameters

companyIdinteger

Company ID (mutually exclusive with other *Id params)

format: int32

personIdinteger

Person ID (mutually exclusive with other *Id params)

format: int32

addressIdinteger

Address ID (mutually exclusive with other *Id params)

format: int32

propertyIdinteger

Property ID (mutually exclusive with other *Id params)

format: int32

vehicleIdinteger

Vehicle ID (mutually exclusive with other *Id params)

format: int32

apartmentIdinteger

Apartment ID (mutually exclusive with other *Id params)

format: int32

Responses

Watchlist memberships for the entity · application/json

watchListGuidstring

format: uuid

watchListNamestring | null
watchListMemberGuidstring

format: uuid