Skip to content

Company Settings

The Company Settings API manage the account information set up for your organization. Formerly known as Enterprise Information.

Find out more about Company Settings
Operations

Get your company settings
Stable

Request

Retrieves the current company settings for the specified enterprise.Use this endpoint to read enterprise-level configuration including contact information, location details, EMM enrollment status, and the enterprise's display name.About Get Company Settings This endpoint (formerly "Get Enterprise Information") returns the EnterpriseV1 object for your enterprise — the root configuration record that identifies your organization within Esper. It includes both read-only system fields (id, short_code, created_on, updated_on, emm) and user-editable fields such as name, contact details, and location. The emm field surfaces whether the enterprise is enrolled in Google EMM and, if so, its google_enterprise_id. All editable fields can be updated via PATCH /v1/enterprise/{enterprise_id}/.

Key Fields

enterprise_id (path, required) — UUID of the enterprise to retrieve

id (read-only) — UUID of the enterprise record

short_code (read-only) — Auto-generated 10-character identifier for the enterprise

name — Display name of the enterprise

registered_name — Formal legal name of the organization

registered_address — Registered business address

location — City, state, and country of the enterprise

contact_person / contact_number / contact_email — Primary point-of-contact details

wifi_lte_toggle_flag — Whether the data saver mode feature is enabled (only present if the feature is active)

emm — Google EMM enrollment details, including google_enterprise_id; null if not EMM-enrolled

Common Use Cases

Reading enterprise metadata to populate an integration's configuration or audit log

Confirming EMM enrollment status and retrieving the linked google_enterprise_id

Retrieving the current values of all editable fields before issuing a PATCH update

Best Practices

Use this endpoint to read current state before calling PATCH — it ensures you don't unknowingly overwrite values you didn't intend to change

Treat id, short_code, created_on, updated_on, and emm as read-only; they cannot be updated via PATCH

Cache the enterprise_id at integration setup time rather than fetching it on every request

Workflow

Call GET /v1/enterprise/{enterprise_id}/ with the enterprise UUID

Inspect the response for the fields relevant to your use case (e.g., emm for EMM enrollment status, contact_email for contact details)

Use the returned field values as the baseline if you plan to follow up with a PATCH update

Security
esper_cloud_api_apiKey
Path
enterprise_idstring, (uuid)required

A UUID string identifying this enterprise.

cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
idstring, (uuid)(Id)read-onlyrequired

Id of the enterprise

namestring, [ 1 .. 255 ] characters(Name)required

Name of the enterprise

short_codestring, [ 1 .. 10 ] characters(Short code)read-onlyrequired

A short 10-char representation of the enterprise, separated by hyphens. Field is optional, as system will auto-generate a value if none is provided.

registered_namestring, [ 1 .. 255 ] characters(Registered name of the enterprise)

Registered Name of the enterprise

registered_addressstring, [ 1 .. 255 ] characters(Registered address)

Registered address of the enterprise.

locationstring, [ 1 .. 255 ] characters(Enterprise location)

City, State, Country location of the enterprise

zipcodestring, [ 1 .. 8 ] characters(Enterprise zipcode)

Zip code of enterprise location

contact_personstring or null, [ 1 .. 255 ] characters(Contact person)

Person who is the point of contact for the enterprise

contact_numberstring or null, [ 1 .. 20 ] characters(Contact number)

Contact number of the enterprise

contact_emailstring, (email), [ 1 .. 254 ] characters(Contact email)

Contact email address of the enterprise

wifi_lte_toggle_flagboolean(Enable data saver mode)

Will only be available if feature is enabled

emmobject or null(Google EMM)read-only

This field will have details about emm enrollment if the enterprise is emm enrolled

created_onstring, (date-time)(Created on)read-only

Date and time of when this resource was created

updated_onstring, (date-time)(Updated on)read-only

Date and time of when this resource was updated

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "short_code": "string",
  "registered_name": "string",
  "registered_address": "string",
  "location": "string",
  "zipcode": "string",
  "contact_person": "string",
  "contact_number": "string",
  "contact_email": "user@example.com",
  "wifi_lte_toggle_flag": true,
  "emm": {
    "google_enterprise_id": "string"
  },
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}