---
updatedAt: 2025-06-04T02:04:21.000Z
agentTools:
  projectIndex: https://securityscorecard.readme.io/v1.7.28/llms.txt
---

# Find followed companies

Searches followed companies by any of the allowed fields. Results are paginated.

# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "info": {
    "title": "All Companies & VSOR Customer API - OpenAPI 2.0",
    "description": "API Definition for All Companies & VSOR Customer Facing API",
    "version": "1.0.0"
  },
  "security": [
    {
      "Token": []
    }
  ],
  "tags": [
    {
      "name": "all-companies",
      "description": "Operations about all followed companies"
    }
  ],
  "paths": {
    "/all-companies": {
      "get": {
        "tags": [
          "all-companies"
        ],
        "summary": "Find followed companies",
        "description": "Searches followed companies by any of the allowed fields. Results are paginated.",
        "operationId": "findFollowedCompanies",
        "parameters": [
          {
            "name": "domain",
            "in": "query",
            "description": "Filter by followed company domain",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "Filter by company name",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tags",
            "in": "query",
            "description": "Filter by custom tag name",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "tags_criteria",
            "in": "query",
            "description": "Filter criteria when filtering by tags field",
            "schema": {
              "type": "string",
              "enum": [
                "AND",
                "OR"
              ]
            }
          },
          {
            "name": "portfolios",
            "in": "query",
            "description": "Filter by portfolio id",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            }
          },
          {
            "name": "portfolios_criteria",
            "in": "query",
            "description": "Filter criteria when filtering by portfolios field",
            "schema": {
              "type": "string",
              "enum": [
                "AND",
                "OR"
              ]
            }
          },
          {
            "name": "monitored",
            "in": "query",
            "description": "Filter by monitored/non-monitored only",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "business_impact",
            "in": "query",
            "description": "Filter by business impact",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "low",
                  "medium",
                  "high",
                  "critical",
                  "none"
                ]
              }
            }
          },
          {
            "name": "lifecycle_status",
            "in": "query",
            "description": "Filter by lifecycle status",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "new",
                  "assess",
                  "respond",
                  "monitor"
                ]
              }
            }
          },
          {
            "name": "data_types_shared",
            "in": "query",
            "description": "Filter by data types shared",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "PII",
                  "PHI",
                  "sensitive",
                  "financial"
                ]
              }
            }
          },
          {
            "name": "risk",
            "in": "query",
            "description": "Filter by risk",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "low",
                  "medium",
                  "high",
                  "critical",
                  "none"
                ]
              }
            }
          },
          {
            "name": "business_unit",
            "in": "query",
            "description": "Filter by business unit",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "product",
                  "engineering",
                  "HR",
                  "finance",
                  "legal",
                  "compliance",
                  "sales",
                  "marketing",
                  "IT",
                  "R&D",
                  "other"
                ]
              }
            }
          },
          {
            "name": "contract_end_date_from",
            "in": "query",
            "description": "Filter by contract end date from YYYY-MM-DD",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "contract_end_date_to",
            "in": "query",
            "description": "Filter by contract end date to YYYY-MM-DD",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "internal_contact",
            "in": "query",
            "description": "Filter by internal contact email",
            "schema": {
              "type": "string",
              "format": "email"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sort by any of the allowed fields. Use \"-\" for DESC order. Default sort by added_date DESC.",
            "schema": {
              "type": "string",
              "enum": [
                "domain",
                "-domain",
                "name",
                "-name",
                "added_date",
                "-added_date",
                "monitored",
                "-monitored",
                "business_impact",
                "-business_impact",
                "lifecycle_status",
                "-lifecycle_status",
                "risk",
                "-risk",
                "business_unit",
                "-business_unit",
                "contract_end_date",
                "-contract_end_date"
              ]
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Current page (zero-based)",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "description": "Results per page",
            "schema": {
              "type": "integer",
              "minimum": 10,
              "maximum": 100,
              "default": 20
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json; charset=utf-8": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "entries": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Company"
                      }
                    },
                    "page": {
                      "type": "integer",
                      "description": "Current page (zero-based)"
                    },
                    "size": {
                      "type": "integer",
                      "description": "Total number of records"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.securityscorecard.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "Token": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "SecurityScorecard API endpoints require an authentication token to be passed\\nin an authorization header in order to return data. If you do not already\\nhave a token, you can create one by going to the API Access area in your\\n[Settings page](https://platform.securityscorecard.io/#/settings/api) and then\\nclicking Generate New Token. Please note this tokens have no expiration\\nso they can be used until manually revoked. If you have a token and generate\\na new one, the previous token will be revoked and can no longer be used.\\n\\nAdministrators can also revoke API tokens for any user in their account.\\n\\nOnce you have your token you can pass it in using the `Authorization` http header like this:\\n\\n```\\ncurl -X GET \\\\\\n  https://api.securityscorecard.io/portfolios \\\\\\n  -H 'authorization: Token \\u003Cyour token\\u003E'\\n```"
      }
    },
    "schemas": {
      "BusinessImpact": {
        "type": "string",
        "description": "Business impact of the company. One of low, medium, high, critical, none",
        "enum": [
          "low",
          "medium",
          "high",
          "critical",
          "none"
        ]
      },
      "LifecycleStatus": {
        "type": "string",
        "description": "Status of the company in the company lifecycle. One of new, assess, respond, monitor",
        "enum": [
          "new",
          "assess",
          "respond",
          "monitor"
        ]
      },
      "DataTypesShared": {
        "type": "string",
        "description": "Data types shared with the company. Any of PII, PHI, sensitive, financial",
        "enum": [
          "PII",
          "PHI",
          "sensitive",
          "financial"
        ]
      },
      "Risk": {
        "type": "string",
        "description": "Riskiness of the company. One of low, medium, high, critical, none",
        "enum": [
          "low",
          "medium",
          "high",
          "critical",
          "none"
        ]
      },
      "BusinessUnit": {
        "type": "string",
        "description": "Business unit that manages the relationship with the company. One of product, engineering, HR, finance, legal, compliance, sales, marketing, IT, R&D, other",
        "enum": [
          "product",
          "engineering",
          "HR",
          "finance",
          "legal",
          "compliance",
          "sales",
          "marketing",
          "IT",
          "R&D",
          "other"
        ]
      },
      "ContractEndDate": {
        "type": "string",
        "description": "Date on which the company's contract ends",
        "format": "date-time"
      },
      "CompanyId": {
        "type": "string",
        "description": "Customer internal ID assigned to the company",
        "example": "example-id"
      },
      "InternalContact": {
        "type": "string",
        "format": "email",
        "description": "Customer internal user email who maintain the relationship with the company",
        "example": "user@example.com"
      },
      "Company": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the company"
          },
          "domain": {
            "type": "string",
            "description": "Domain of the company",
            "example": "example.com"
          },
          "name": {
            "type": "string",
            "description": "Name of the company",
            "example": "Example Inc"
          },
          "added_date": {
            "type": "string",
            "format": "date-time",
            "description": "Date on which the company started to be followed"
          },
          "tags": {
            "description": "Tags visible to the current user that are linked to the company",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "name": {
                  "type": "string",
                  "example": "Example-Tag-01"
                }
              }
            }
          },
          "portfolios": {
            "description": "Portfolios visible to the current user where the company belongs to",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "name": {
                  "type": "string",
                  "example": "Example Portfolio"
                }
              }
            }
          },
          "monitored": {
            "description": "Flag that determines if the company is monitored (belongs to at least one portfolio) or non-monitored",
            "type": "boolean"
          },
          "business_impact": {
            "$ref": "#/components/schemas/BusinessImpact"
          },
          "lifecycle_status": {
            "$ref": "#/components/schemas/LifecycleStatus"
          },
          "data_types_shared": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DataTypesShared"
            }
          },
          "risk": {
            "$ref": "#/components/schemas/Risk"
          },
          "business_unit": {
            "$ref": "#/components/schemas/BusinessUnit"
          },
          "contract_end_date": {
            "$ref": "#/components/schemas/ContractEndDate"
          },
          "vendor_id": {
            "$ref": "#/components/schemas/CompanyId"
          },
          "internal_contact": {
            "$ref": "#/components/schemas/InternalContact"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
````