Skip to main content
POST
/
companies
/
search
AI company search
curl --request POST \
  --url https://api.village.do/v1/companies/search \
  --header 'Content-Type: application/json' \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>' \
  --data '{
  "query": "Fintech companies in London",
  "page": 123,
  "limit": 25
}'
{
  "success": true,
  "data": [
    {
      "id": "acme-corp",
      "type": "company",
      "name": "Acme Corporation",
      "linkedinId": 12345678,
      "linkedinUrl": "https://www.linkedin.com/company/acme-corp",
      "website": "https://www.acme-corp.com",
      "domain": "acme-corp.com",
      "employeeSize": 150,
      "sizeRange": "101-250",
      "founded": 2015,
      "description": "A leading technology company specializing in innovative software solutions for enterprise clients."
    },
    {
      "id": "global-solutions",
      "type": "company",
      "name": "Global Solutions Inc",
      "linkedinId": 87654321,
      "linkedinUrl": "https://www.linkedin.com/company/global-solutions",
      "website": "https://www.globalsolutions.com",
      "domain": "globalsolutions.com",
      "employeeSize": 75,
      "sizeRange": "51-100",
      "founded": 2018
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 2,
    "hasNextPage": true
  },
  "meta": {
    "query": "Fintech companies in London",
    "searchType": "ai",
    "apiVersion": "v1"
  }
}

Authorizations

x-access-token
string
header
required

JWT token obtained from /users/authorization endpoint

Headers

user-identifier
string
required

Specify the user making the request. This identifier should match the one you used when integrating the user with Village. Not needed when using user token authentication.

Body

application/json
query
string
required

Natural language search query

Example:

"Fintech companies in London"

page
integer

Page number for pagination

limit
integer
default:25

Number of results per page

Required range: x <= 100

Response

Successfully processed AI search query

success
boolean

Indicates if the request was successful

data
object[]

Array of company search results

pagination
object
meta
object
I