Company Search

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

Search for child companies.

Recipes

📆

Service first customer appointment booking journey

Open Recipe

Path Params

company_id

int32

required

Query Params

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)

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

enabled_only

boolean

Only return companies that are not disabled

person_id

int32

Filter based on Person

Response

Response body

object

total_entries

integer

_embedded

object

companies

array of objects

companies

object

integer

name

string

description

string

company_type

string

extra

object

address_id

integer

website

string

multi_status

string

reference

string

numeric_widget_id

integer

currency_code

string

timezone

string

country_code

string

live

boolean

ref

string

created_at

string

updated_at

string

children_count

integer

locale

string

available_locales

string

membership_id

integer

address

object

          Retrieves an address.

_embedded

object

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.jrni.com/api/v5/company/company_id/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 Collection