API v1 ReferenceCompanies

Returns the company with the specified id.

Returns the company with the specified id.

Required Permissions
The user must be an admin or have company-master-data:read permissions.

Path parameters

companyIdUUIDRequired

The id of the company.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK

namestring>=0 characters<=1000 characters

The company name.

descriptionstring or nullOptional>=0 characters<=25000 characters

The company description.

industrystring or nullOptional>=0 characters<=1000 characters

The company’s industry.

idUUIDOptional

The id of the company.

hasImagebooleanOptional

Whether the company has an image.

companyContactInfoslist of objectsOptional

The company infos assigned to this company.

createdOndatetimeOptional

The date this entity was created.

createdByUUIDOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedByUUIDOptional

The id of the user who last modified this entity.

resourceVersionlongOptional

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

tagslist of objectsOptional

The tags for this company.

projectsCountintegerOptional

The number of all projects related to the company.

projectsInProgressCountintegerOptional

The number of all projects in status ‘progress’ related to the company.

isExternalbooleanOptional

True if this entity is coming from an external workspace (awork Connect).