A collection of help pages for using the API.
| URL | /Api/v2/Company/{companyId} |
| Accepted verbs | GET, PUT, DELETE |
| Description |
Provides methods to get or manage companies. |
Get a list of all companies for the user. The default behaviour is that the response contains all companies that the user is connected to. If the parameter showAll is set to 'true', the list will contain a list of all companies that the user has access to, regardless if the user is directly connected to that company or not. For example, agency director have the right to see all companies under the agency, but might not be directly connected to all of them.
| Name | Description | Additional information |
|---|---|---|
| showAll | Get a list of all accessible companies if set to 'true'. Only get a list of directly connected companies if set to 'false' (default). |
URI parameter |
The requested list of CompanyInfo.
Get a single company.
| Name | Description | Additional information |
|---|---|---|
| companyId | Company id |
URI parameter |
The requested CompanyInfo.
Update a company.
| Name | Description | Additional information |
|---|---|---|
| companyId | Company id |
URI parameter |
| apiCompany | Updated CompanyInfo information. |
Body data |
The CompanyInfo with updated information.
When a company is being deleted it will also delete all users that does not have any connection to other companies. I.e. company users that were created only for this company will be deleted from the system, while agency consultants that works with many other companies will remain in the system and only remove their connection to the deleted company.
| Name | Description | Additional information |
|---|---|---|
| companyId | Id of the company to delete. |
URI parameter |