RErecordedfuture
List

GET /list/{listId}/status

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

Request

  • Base URL
    https://api.recordedfuture.com
  • URL
    https://api.recordedfuture.com/list/{listId}/status
  • Auth
    • API key in header X-RFToken
    • or OAuth 2
      Authorization code: https://id.recordedfuture.com/authorize
      Token URL: https://id.recordedfuture.com/token

Response

Success

sizeinteger required

Current number of entities in the list.

status'pending' | 'processing' | 'ready' required

pending — awaiting initial processing after being added; processing — currently being indexed; ready — fully processed and available for use in alerts and queries.

Changes

No recorded changes to this operation across all 1 revision of this API.