Company Search

get https://{api_url}/api/v5/admin/{company_id}/company/search

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

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

Company ID

Query Params

embed

string

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

strategy

string

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

include_self

boolean

Indicate if response includes current company

company[text]

string

Company name, description or reference

company[company_type]

string

Company type, physical (default) or virtual

address[lat]

string

required

Address latitude

address[long]

string

required

Address longitude

address[radius]

int32

Address Search radius(km)

enabled_only

boolean

Only return companies that are enabled

service_id

int32

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

page

int32

Defaults to 1

per_page

int32

Defaults to 30

Response

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.jrni.com/api/v5/admin/company_id/company/search?strategy=leafs&page=1&per_page=30' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Company with the given ID