/list/{listId}/entitiesWithTags

Returns all entities in the specified list along with their assigned tags.

What this endpoint does

Retrieves all entities in a list along with their assigned tags. This is the tag-aware counterpart to Lists: Get Entities — use this endpoint when you need to see which tags have been applied to each entity via Lists: Replace Entity Tags.

This endpoint is intended for the Third-Parties Watch List (company-type lists where type is "company" in the Lists: Search response). Calling it on other list types will not return an error — it will return entities with empty tags arrays, which is indistinguishable from tagged entities that simply have no tags assigned. Returns 400 if the list has not been migrated to support tags, and 404 if the list does not exist.

Response data

Returns a bare JSON array of all entities with no pagination — all entities are returned in a single response. Each entry includes the entity's identity (ID, name, type), processing status, the timestamp when it was added to the list, and the full set of tags currently applied. Each tag includes an id (format enum:EntityListTag:<tagname>) and name — these correspond to the predefined tag values listed in Lists: Available Tags. If an entity has no tags, the tags array is empty. This is the only endpoint that surfaces tag assignments on list entities — the standard Lists: Get Entities response does not include tag data.

Path Params
string
required

Unique identifier for a list (format: report:XXXXX) or a named watch list identifier, obtained from POST /list/search or POST /list/create.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json