Company Search

Search for child companies, load all of the links and properties of those companies

Path Params
string
required

Company ID

Query Params
string

A comma separated list of resources to embed. Available: address

string
enum
Defaults to leafs

Indicate how it searches company tree
Default strategy leafs to consist with current behaviour
leafs: returns all leaf companies (companies have no children), in GP-P-C structure, this returns only C
children: returns only children companies, in GP-P-C structure, this returns only P
descendants: returns all descendant companies in the hierarchy tree, in GP-P-C structure, this returns P and C

Allowed:
boolean

Indicate if response includes current company

string

Company name, description or reference

string
enum

Company type, physical (default) or virtual

Allowed:
string
required

Address latitude

string
required

Address longitude

int32

Address Search radius(km)

boolean

Only return companies that are enabled

int32

A parent-level ID of a service which the companies provide

int32
Defaults to 1
int32
Defaults to 30
Response

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json