v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB
Company

Retrieve a company

Retrieves company information for a company specified by the provided identifier (companyId)

get/v4/companies/{companyId}

Path parameters

companyIdstring required

The company's unique identifier

Response

OK - Company information was successfully retrieved

company_idstring

Company identifier

namestring

Company name

descriptionstring

Company description

websitestring

Company website

contactstring

The company's contact information

account_managerstring

Company account manager

tenantIdstring

Tenant identifier

subTenantIdstring

Sub-tenant identifier (it will match the tenantId if the company is not part of a super tenant)

Example response

{
  "company_id": "1f6841a8-7f3b-4505-856e-4549be433545",
  "name": "My Company",
  "description": "This is an example company",
  "website": "https://company.com",
  "contact": "email@company.com",
  "account_manager": "Joe Blow",
  "tenantId": "my-tenant",
  "subTenantId": "my-tenant"
}