/list/{listId}/status

Returns the processing status and entity count for a specific list.

What this endpoint does

This operation returns the processing status and entity count for a specific Recorded Future list. Use this endpoint to check whether a list's entities have been fully indexed after adding or removing entities via the Lists: Add Entity or Lists: Remove Entity endpoints. This is particularly useful when working with large lists or when list contents need to be fully processed before being used in alerts or queries within the Recorded Future platform. For list metadata such as name, type, and ownership, use the Lists: Get Info endpoint instead.

Response data

The response contains a size field indicating the current number of entities in the list, and a status field reflecting the list's processing state: pending (awaiting initial processing), processing (currently being indexed), or ready (fully processed and available for use in platform features like alerting and monitoring).

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