Returns all companies.

GET

Returns all companies.

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

Query parameters

pageintegerOptionalDefaults to 1

Page number for pagination

pageSizeintegerOptionalDefaults to 10

Number of items per page

orderbystringOptional

The properties to order by

filterbystringOptional

The filter expression to filter by

Response

OK

namestring>=0 characters<=1000 characters

The company name.

descriptionstringOptional>=0 characters<=25000 characters

The company description.

industrystringOptional>=0 characters<=1000 characters

The company’s industry.

idstringOptional

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.

createdBystringOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedBystringOptional

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).

Creates a new company.
Built with