Skip to content

Companies

Endpoints for company management

Operations

Retrieve a company by id

Request

Security
OAuth2(Required scopes: companies.read)
Path
idstring(CompaniesId)required

Id of the company to retrieve

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

Responses

Successful Response

Bodyapplication/json
namestring(Companies display name)required
Example:"Companies Name Inc."
idstring(Companies identifier)required
Example:"63e6663823b4c1f5287398bb"
activeboolean(Companies activity flag)required
Example:true
createdAtstring(Companies creation date)required
Example:"1990-12-31T15:46:19.384990Z"
Response
{
  "name": "Companies Name Inc.",
  "id": "63e6663823b4c1f5287398bb",
  "active": true,
  "createdAt": "1990-12-31T15:46:19.384990Z"
}