Company API
The Company API manages company records in Deepser. Companies represent the organizations associated with your users, Service Operations, and CIs. This section describes the endpoints, role-based permissions, and available fields.
Only Administrators with access to the Company Module can create, update, and delete companies. Operators and Key Users can only retrieve company records. End Users cannot access this resource via the API.
Endpoints
http://deepserhost/api/rest/company/[id]
http://deepserhost/api/rest/companies
Roles
| Administrator | Operator | Key User | User | |
|---|---|---|---|---|
| Actions Allowed | RETRIEVE CREATE UPDATE DELETE | RETRIEVE | RETRIEVE |
Fields
The following table lists all fields of the Company entity:
| Field | Description |
|---|---|
| entity_id | The unique ID of the record. |
| name | The company name, displayed in select boxes throughout the system. |
| parent_id | The parent company ID. Setting a parent creates a sub-company (branch) relationship. Deepser supports a maximum of 2 levels in the company hierarchy by default (e.g., a head office with regional branches). Attempting to add a third level returns a blocking error. This limit can be extended through customization. |
| description | Description of the company. |
| status | Whether the company is active. Disabled companies do not appear in select boxes. |
| mailbox_id | The mailbox used to send emails to users of this company. When set, all notifications for this company's users are sent from this specific mailbox rather than the system default. If not set, Deepser uses the default outgoing mailbox or any record-specific outgoing mailbox. |
| logo | Company logo image. |
| address | Street address. |
| city | City. |
| state | State or area. |
| country | Country. |
| zip_code | Postal code. |
| primary_contact | The Deepser user designated as the primary contact for this company. |
| phone | Main phone number. |
| fax | Fax number. |
| notes | Internal notes. |
| formtemplate_id | The form template ID used by the record. |
| updated_at | Date of the last update. |
| created_at | Creation date of the record. |