Retrieve a list of companies

Request

Note: For now pagination is not implemented

Security

OAuth2(Required scopes: companies.read)

curl -i -X GET \
  https://api.cloud.hypatos.ai/v2/companies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json

dataArray of objects(Companies list)required

limitinteger(The limit used for this page of results. This will be the same as the limit query parameter unless it exceeds the maximal allowed value.)required

Example:20

offsetinteger(The offset used for this page of results. This will be the same as the offset query parameter.)required

Example:0

totalCountinteger(The total number of elements of the data attribute.)required

Example:1000

Response

{
  "data": [
    { … }
  ],
  "limit": 20,
  "offset": 0,
  "totalCount": 1000
}