Skip to content

Get your company settings
Stable

Request

Returns company settings. Formerly known as get your enterprise information.

Security
apiKey
Path
enterprise_idstring, (uuid)required

A UUID string identifying this enterprise.

cURL
curl -i -X GET \
  'https://develop-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"
}