companies

Returns all companies.

Changed on

Returns all companies in the workspace.

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

get/companies

Request

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

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

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