---
title: List search types
slug: andrei/list-search-types
createdAt: 2026-10-05T10:36:01.732Z
---

{
  "id": "CWew_l-tAKI9sWkaslBZy",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.detected.app/api/v2/public/search/types",
    "servers": [
      {
        "url": "https://api.detected.app/api/v2/public/search/types",
        "description": "Production"
      }
    ],
    "name": "List search types",
    "description": "<p>Returns the entity types that can be searched, and whether search is enabled for each.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "AccessToken",
          "name": "AccessToken",
          "kind": "optional",
          "type": "http",
          "description": "<p>The API uses OAuth 2.0. Request an access token from <code>POST /oauth/token</code> with the client ID and client secret of your integration client, and your account slug. Send the access token in the <code>Authorization</code> header of every request, in the format <code>Authorization: Bearer &#x3C;access_token></code>. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "headers": [
          {
            "kind": "optional",
            "name": "X-RateLimit-Limit",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "X-RateLimit-Remaining",
            "description": ""
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "SearchTypesResponse",
            "schema": [
              {
                "name": "company",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "sole_trader",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "partnership",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "charity",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "government_entity",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "incorporated_syndicate",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "company_syndicate",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "syndicate",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "association",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "trust",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "fund",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "individual",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "joint_individual",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              },
              {
                "name": "club",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/EntityTypesConfig",
                "customType": "EntityTypesConfig",
                "schema": [
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the entity type."
                  },
                  {
                    "name": "search_enabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Whether search is enabled for the entity type."
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/SearchTypesResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized. The access token is missing, invalid or has expired.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "429",
        "description": "<p>Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.detected.app/api/v2/public/search/types \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.detected.app/api/v2/public/search/types\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.detected.app/api/v2/public/search/types\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.detected.app/api/v2/public/search/types\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK\n{\n  \"company\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"sole_trader\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"partnership\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"charity\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"government_entity\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"incorporated_syndicate\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"company_syndicate\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"syndicate\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"association\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"trust\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"fund\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"individual\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"joint_individual\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  },\n  \"club\": {\n    \"label\": \"\",\n    \"search_enabled\": false\n  }\n}"
        },
        {
          "id": "response-1-401",
          "language": "401",
          "code": "// Unauthorized. The access token is missing, invalid or has expired.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-2-429",
          "language": "429",
          "code": "// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}