Companies

Get all companies

Returns all company profiles of the enterprise, possibly filtered by identifiers, names or other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/companies/getAll

Request

  • Base URL: https://api.mews.com
  • URL: https://api.mews.com/api/connector/v1/companies/getAll
  • Auth: none declared

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

ChainIdsstring[] nullable

Unique identifiers of Chain. If not specified, the operation returns data for all chains within scope of the Access Token.

MotherCompanyIdsstring[] nullable

Unique identifiers of mother Company.

TimeFilter'Created' | 'Updated' nullable
StartUtcstring date-time nullable
EndUtcstring date-time nullable
Idsstring[] nullable

Unique identifiers of Companies.

ExternalIdentifiersstring[] nullable

Identifiers of Company from external system.

Namesstring[] nullable

Names of Companies.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted records will be returned.

Response

OK

Cursorstring uuid nullable

Unique identifier of the last and hence oldest company item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older companies. If Limitation is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.

Changes

No recorded changes to this operation across all 18 revisions of this API.