Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
List

Searches for lists matching optional name, type, and limit filters.

post/list/search

Request body

namestring

Substring match against list names.

type'entity' | 'source' | 'text' | 'custom' | 'ip' | 'domain' | 'tech_stack' | 'industry' | 'brand' | 'partner' | 'industry_peer' | 'location' | 'supplier' | 'vulnerability' | 'company' | 'hash' | 'operation' | 'attacker' | 'target' | 'method' | 'executive'
limitinteger

Example request

{
  "name": "Russian Hackers"
}

Response

Success

idstring required
namestring required
type'entity' | 'source' | 'text' | 'custom' | 'ip' | 'domain' | 'tech_stack' | 'industry' | 'brand' | 'partner' | 'industry_peer' | 'location' | 'supplier' | 'vulnerability' | 'company' | 'hash' | 'operation' | 'attacker' | 'target' | 'method' | 'executive' required
createdstring date-time required
updatedstring date-time required
owner_idstring

Id of the Owner

owner_namestring

Name of the Owner

organisation_idstring

Id of the Organisation

organisation_namestring

Name of the Organisation

Example response

[
  {
    "id": "report:P6LnLw",
    "name": "Russian Hackers",
    "created": "2023-01-01T13:00:00Z",
    "updated": "2023-01-01T13:00:00Z",
    "owner_id": "uhash:3HX1Rn1Ke",
    "owner_name": "Recorded Future",
    "organisation_id": "uhash:3HX3rIn4Kv",
    "organisation_name": "Recorded Future",
    "owner_organisation_details": {
      "owner_id": "uhash:3HX1Rn1Ke",
      "owner_name": "Recorded Future",
      "organisations": [
        {
          "organisation_id": "uhash:3HX3rIn4Kv",
          "organisation_name": "Recorded Future"
        }
      ],
      "enterprise_id": "uhash:1HX2qIn4Zy",
      "enterprise_name": "Recorded Future"
    }
  }
]