Skip to main content
POST
/
api
/
zefix
/
companies
/
search
/zefix/companies/search
curl --request POST \
  --url https://api.anysite.io/api/zefix/companies/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "count": 2500,
  "timeout": 300,
  "search_type": "containing",
  "language_key": "en",
  "active_only": false,
  "deleted_only": false
}
'
[
  {
    "name": "<string>",
    "@type": "@zefix_search_company",
    "ehraid": 123,
    "uid": "<string>",
    "uid_formatted": "<string>",
    "chid": "<string>",
    "chid_formatted": "<string>",
    "legal_seat": "<string>",
    "legal_seat_id": 123,
    "register_office_id": 123,
    "legal_form_id": 123,
    "status": "<string>",
    "shab_date": "<string>",
    "delete_date": "<string>",
    "cantonal_excerpt_web": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
name
string
required

Company name or UID to search for

Minimum string length: 1
Example:

"Nestle"

​
count
integer
required

Max number of results

Required range: 1 <= x <= 5000
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
search_type
enum<string>
default:containing

Name matching mode

Available options:
exact,
containing,
startingWith
​
language_key
enum<string>
default:en

Result language

Available options:
de,
fr,
it,
en
​
active_only
boolean
default:false

Return only active (existing) companies

​
deleted_only
boolean
default:false

Return only deleted companies

Response

Successful Response

​
name
string
required
​
@type
string
default:@zefix_search_company
​
ehraid
integer | null
​
uid
string | null
​
uid_formatted
string | null
​
chid
string | null
​
chid_formatted
string | null
​
legal_seat
string | null
​
legal_seat_id
integer | null
​
register_office_id
integer | null
​
legal_form_id
integer | null
​
status
string | null
​
shab_date
string | null
​
delete_date
string | null
​
cantonal_excerpt_web
string | null