WIwindmill-growth
Customer REST

List watchlist profiles.

Changed on
get/customer/watchlist/profiles

Request

Query parameters

limitinteger

Number of items to return. The default is 50 and the maximum is 100.

cursorstring

Opaque cursor returned in page.nextCursor. Pass it unchanged with the same filters and sort. Incompatible cursors return validation_failed.

entityType'PERSON' | 'COMPANY'

Tracked people (PERSON) or tracked companies (COMPANY), as Tracking's People and Companies tabs. Both when omitted.

profileType'TEAMMATE' | 'COMPETITOR' | 'INFLUENCER' | 'INVESTOR' | 'CUSTOM' | 'TARGET_ACCOUNT' | 'CUSTOMER' | 'PARTNER'
profileTypesstring

Comma-separated profile types. Accepts up to five values.

source'MEMBER_ONBOARDING' | 'MANUAL_WATCHLIST'
slotKind'SELF' | 'STANDARD' | 'COMPETITOR'
relationshipLabelstring
state'ACTIVE' | 'PAUSED'
querystring
sort'createdAt' | 'followers' | 'lastEngagementSyncAt' | 'displayName' | 'qualifiedLeads'

qualifiedLeads ranks by each profile's leads, the count in Tracking's leads column (qualifiedLeadsTotal on each row).

sortDirection'asc' | 'desc'

Response

Paginated watchlist profiles with how many match the filters across all pages.

dataobject[] required
totalinteger required

Profiles matching the filters across all pages.

Changes

  • 765b1a6a3abdRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the new optional query request parameter entityType

    • info

      added the new enum value qualifiedLeads to the query request parameter sort

    • info

      added subschema #2 to the response body allOf list for the response status

  • 5dad61cc8aeaRevision changes
    • info

      added the new enum value CUSTOMER to the query request parameter profileType

    • info

      added the new enum value PARTNER to the query request parameter profileType

    • info

      added the new enum value TARGET_ACCOUNT to the query request parameter profileType