companies

Returns the specified company.

Changed on

Returns the specified company. External companies omit contact information, tags, project counts, descriptions, and industries.

<Check title="Required Permissions" icon="key">The user must be an admin or have company-master-data:read permissions.</Check>

get/companies/{companyId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/companies/{companyId}
  • Auth: HTTP bearer

Path parameters

companyIdstring uuid required

The id of the company.

Response

OK

namestring required

The company name.

descriptionstring nullable

The company description.

industrystring nullable

The company's industry.

idstring uuid

The id of the company.

hasImageboolean

Whether the company has an image.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

resourceVersioninteger

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

projectsCountinteger

The number of all projects related to the company.

projectsInProgressCountinteger

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

isExternalboolean

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetCompanyById removed and replaced with companies_GetCompanyById