/companies

get

https://rz3.aeb.de/test4ce/rest/companies

Returns all companies matching the given filter criteria. In case no company matches the given filter criteria an empty companies collection is returned. All filter fields are case insensitive. If the filter field supports place holders ('*' or '%'), you get all companies back beginning with the value of the filter. Means a place holder at the end of the filter value is added automatically.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

is_enabled

boolean

Use this filter field with value 'true' if you want to get enabled companies only.

roles

array of strings

Filters companies by company roles. Use the API method GET/company-roles to retrieve all company roles. When searching for more than one role, all companies including one of the given roles are returned.
This filter field is case insensitive.
Place holders are not supported.

roles

company_number_like

string

Filters companies by company number.
In the example, all companies whose company number begins with '123' are returned.
This filter field is case insensitive.
Place holders are supported.
The company number is in some AEB services not unique, so the result may return more than one company with the same company number.

name_like

string

Filters companies by name.
In the example, all companies whose name begins with 'AEB' are returned.
This filter field is case insensitive.
Place holders are supported.

city_like

string

Filters companies by city.
In the example, all companies whose city includes 'ttgart' are returned.
This filter field is case insensitive.
Place holders are supported.

postcode_like

string

Filters companies by postcode.
In the example, all companies whose postcode starts with '70' are returned.
This filter field is case insensitive (relevant for alphanumeric postcodes, like in GB).
Place holders are supported.

country_iso_code

string

length between 2 and 2

Filters companies by the 2 digit country ISO code according to ISO 3166. Examples for valid codes: 'US' for USA, 'DE' for Germany, 'IT' for Italy, etc.
In the example, all German companies are returned.
This filter field is case insensitive.
Place holders are not supported.

offset

int32

≥ 0

Defaults to 0

The starting point from which to return elements of the ordered list.
Minimum : 0

limit

int32

1 to 1000

Defaults to 1000

The maximum number of elements to be returned from the ordered list.
Minimum : 1
Maximum : 1000

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful call

400Either the requested company role is unknown or something went wrong during the validation.