Zum Hauptinhalt springen
POST
/
api
/
v1
/
companies
/
search
/
Search companies
curl --request POST \
  --url https://www.firmium.de/api/v1/companies/search/ \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "registration_number": "<string>",
  "status": "Active",
  "deep": false
}'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "registration_number": "<string>",
      "country": "<string>",
      "status": "Active"
    }
  ]
}

Authorizations

​
sessionid
string
cookie
required

Query Parameters

​
euid
string
​
founded_after
string<date>
​
founded_before
string<date>
​
legal_form
string
​
name
string
​
page
integer

A page number within the paginated result set.

​
registration_number
string
​
status
enum<string>
  • Active - Active
  • Inactive - Inactive
  • In Liquidation - In Liquidation
  • Dissolved - Dissolved
  • Bankrupt - Bankrupt
  • Restructuring - Restructuring
Verfügbare Optionen:
Active,
Bankrupt,
Dissolved,
In Liquidation,
Inactive,
Restructuring
​
vat_number
string

Body

Serializer for company search

​
name
string
required
Maximum length: 255
​
registration_number
string

Local registry number

Maximum length: 100
​
status
enum<string>
  • Active - Active
  • Inactive - Inactive
  • In Liquidation - In Liquidation
  • Dissolved - Dissolved
  • Bankrupt - Bankrupt
  • Restructuring - Restructuring
Verfügbare Optionen:
Active,
Inactive,
In Liquidation,
Dissolved,
Bankrupt,
Restructuring
​
deep
boolean
default:false

Include external business registry search for more complete results (slower)

Response

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"