Skip to main content

company

Retrieve detailed information about a specific company.

Returns comprehensive company data including contact information, organizational structure, and associated metadata. Access is restricted based on user permissions and company relationships.

Possible errors:

  • COMPANY_NOT_FOUND_ERROR: Company with the specified ID does not exist
  • COMPANY_FETCH_ERROR: Failed to retrieve company information

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

company(
id: Int!
): Company!

Arguments

company.id ● Int! non-null scalar

Unique identifier of the company to retrieve.

Must be a positive integer representing a valid company ID in the system.

Type

Company object

Company entity representing business organizations and corporate entities.

External entity from the company service that provides company identification and business information. Used as a reference for company-specific attributes and organizational relationships within the attribute system.