---
updatedAt: 2025-06-25T16:02:17.000Z
agentTools:
  projectIndex: https://docs.beauhurst.com/llms.txt
---

# Quicksearch - BETA

Enter at least 3 characters. Returns paginated list of company data: ID, name and country

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Beauhurst API",
    "description": "<h3>Usage</h3><p>The API only accepts <code>GET</code> requests over HTTPS.</p><h3>Authorization</h3><p>The Beauhurst API requires authentication in the form of an API key. To obtain an API key, please contact your subscription's account manager at Beauhurst. Be sure to keep this key <strong>private</strong> and <strong>secure</strong>.</p>",
    "version": "beauhurstapi"
  },
  "security": [
    {
      "ApiKey": []
    }
  ],
  "paths": {
    "/v1/companies/quicksearch": {
      "get": {
        "operationId": "v1_companies_quicksearch",
        "summary": "Search for companies by company name, company website or company ID using the quick search logic",
        "description": "Takes at least 3 characters. Returns paginated list of company data: ID, name, stage of evolution and country",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "description": "Number of results to return per page.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The initial index from which to return the results.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "term",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          {
            "name": "max_suggestions",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 15,
              "default": 10
            }
          },
          {
            "name": "mode",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "quick",
                "slow"
              ],
              "default": "quick"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "total",
                    "limit",
                    "offset",
                    "count",
                    "results"
                  ],
                  "type": "object",
                  "properties": {
                    "total": {
                      "description": "Total number of items available.",
                      "type": "integer"
                    },
                    "limit": {
                      "description": "Number of results to return per page.",
                      "type": "integer"
                    },
                    "offset": {
                      "description": "The initial index from which to return the results.",
                      "type": "integer"
                    },
                    "count": {
                      "description": "number of results returned",
                      "type": "integer"
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "required": [
                          "id",
                          "name",
                          "country"
                        ],
                        "type": "object",
                        "properties": {
                          "id": {
                            "title": "Id",
                            "type": "string",
                            "minLength": 1
                          },
                          "name": {
                            "title": "Name",
                            "type": "string",
                            "minLength": 1
                          },
                          "country": {
                            "title": "Country",
                            "type": "string",
                            "minLength": 1
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "v1"
        ]
      },
      "parameters": []
    }
  },
  "servers": [
    {
      "url": "https://platform.beauhurst.com/_api"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "name": "Authorization",
        "description": "Beauhurst API key",
        "in": "header"
      }
    }
  }
}
```