Powered by Redocly

Companies

Endpoints for company management

Retrieve a company by id

SecurityOAuth2
Request
path Parameters
id
required
string (CompaniesId)

Id of the company to retrieve

Example: 63e6663823b4c1f5287398bb
Responses
200

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Error

429

Rate limit exceeded

500

Internal Server Error

get/companies/{id}
Request samples 
curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/companies/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "name": "Companies Name Inc.",
  • "id": "63e6663823b4c1f5287398bb",
  • "active": true,
  • "createdAt": "1990-12-31T15:46:19.384990Z"
}

Retrieve a list of companies

Note: For now pagination is not implemented

SecurityOAuth2
Responses
200

Successful Response

422

Validation Error

429

Rate limit exceeded

get/companies
Request samples 
curl -i -X GET \
  https://api.cloud.hypatos.ai/v2/companies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "data": [
    ],
  • "limit": 20,
  • "offset": 0,
  • "totalCount": 1000
}
➔ Next to Projects