API v1 ReferenceCompanies

Returns all companies.

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

Authentication

AuthorizationBearer

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

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.
descriptionstring or null>=0 characters<=25000 characters
The company description.
industrystring or null>=0 characters<=1000 characters
The company's industry.
idstring or nullformat: "uuid"
The id of the company.
hasImageboolean or null
Whether the company has an image.
companyContactInfoslist of objects or null
The company infos assigned to this company.
createdOnstring or nullformat: "date-time"
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOnstring or nullformat: "date-time"
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.
resourceVersionlong or null
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
tagslist of objects or null
The tags for this company.
projectsCountinteger or null
The number of all projects related to the company.
projectsInProgressCountinteger or null
The number of all projects in status 'progress' related to the company.
isExternalboolean or null

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