Skip to main content
POST
/
api
/
companies_house
/
officers
/
search
/companies_house/officers/search
curl --request POST \
  --url https://api.anysite.io/api/companies_house/officers/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "officer_id": "<string>",
    "title": "<string>",
    "@type": "@companies_house_officer_search_result",
    "appointment_count": 0,
    "address_snippet": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
query
string
required

Officer name search query

Example:

"John Smith"

​
count
integer
required

Max number of results

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
officer_id
string
required
​
title
string
required
​
@type
string
default:@companies_house_officer_search_result
​
appointment_count
integer
default:0
​
address_snippet
string | null