🔀 collections

The collections relationship returns a list of collections for a given user.

This relationship can be retrieved by using the relationships API endpoint and returns a list containing collection objects.

This relationship accepts both order and filter arguments:

Possible orders (ending on + or -):

last_modification_date
subscribers_count
creation_date

Possible filter modifiers:

name

For example, if we want Joe's collections sorted by most recently created first and containing 'emotet' in the collection's name we will do the following request:
https://www.virustotal.com/api/v3/users/Joe/collections?order=creation_date-&filter=name:emotet.

{
  "data": [
    <COLLECTION_OBJECT>
    ...
  ],
  "links": {
    "next": <string>,
    "self": <string>
  },
  "meta": {
    "count": <int>,
    "cursor": <string>
  }
}

{
  "meta": {
    "count": 2,
    "cursor": "CocBChoKDWNyZWF0aW9uX2RhdGUSCQjmsteuveDyAhJlahFzfnZpcnVzdG90YWxjbG91ZHJQCxIKQ29sbGVjdGlvbiJAZGUyZGM5MmU5ZThkYTQ3OWVmY2JkZjczMTBhMWI1ZTY3ODgxYmYxMGRjOTFmNmU1ZjcxNTlhNTJjMjlhODEyZQwYACAB"
  },
  "data": [
    {
      "attributes": {
        "description": "Test collection",
        "name": "Prevx infected",
        "tags": [],
        "ip_addresses_count": 0,
        "targeted_industries": [],
        "domains_count": 0,
        "creation_date": 1630592216,
        "references_count": 0,
        "alt_names": [],
        "urls_count": 0,
        "autogenerated_tags": [
          "bobsoft",
          "pecompact",
          "themida",
          "rlpack",
          "yoda",
          "mew",
          "aspack",
          "nspack",
          "attachment",
          "pespin",
          "molebox",
          "telock",
          "yodaprot",
          "ahpack",
          "armadillo",
          "execryptor",
          "upack",
          "asprotect",
          "xorcrypt",
          "fsg",
          "ntkrnl",
          "upx"
        ],
        "last_modification_date": 1630592216,
        "top_icon_md5": [
          "4e36c557b0188de9290a9ff9685cce17",
          "5fff7c360c84b7ad1554b722598fb43c",
          "44abfa8c8002712b3ed19f8f2847dd0d"
        ],
        "targeted_countries": [],
        "files_count": 1234
      },
      "type": "collection",
      "id": "de2dc92e9e8da479efcbdf7310a1b5e67881bf10dc91f6e5f7159a52c29a812e",
      "links": {
        "self": "https://www.virustotal.com/api/v3/collections/de2dc92e9e8da479efcbdf7310a1b5e67881bf10dc91f6e5f7159a52c29a812e"
      }
    }
  ],
  "links": {
    "self": "https://www.virustotal.com/api/v3/users/roadrunner/collections?filter=name%3Ainfected&limit=1&order=creation_date-",
    "next": "https://www.virustotal.com/api/v3/users/roadrunner/collections?filter=name%3Ainfected&cursor=CocBChoKDWNyZWF0aW9uX2RhdGUSCQjmsteuveDyAhJlahFzfnZpcnVzdG90YWxjbG91ZHJQCxIKQ29sbGVjdGlvbiJAZGUyZGM5MmU5ZThkYTQ3OWVmY2JkZjczMTBhMWI1ZTY3ODgxYmYxMGRjOTFmNmU1ZjcxNTlhNTJjMjlhODEyZQwYACAB&limit=1&order=creation_date-"
  }
}