Developer Center

Organisational Settings API

Last Updated: Feb 20, 2017 04:33PM CET

URL

/api/settings/organization
/api/settings/branding/logo
/api/settings/branding/icon
/api/settings/general
/api/settings/labels

Description

Get information from the current organisation. Logo and icons will be returned as a base64 encoded data image. 

Methods

GET Organisational Settings

Usage examples
//get details of the organisation
GET /api/settings/organization

//get the logo (300x50 pixels) and the icon (16x16 pixels)
GET /api/settings/branding/logo
GET /api/settings/branding/icon

//get the settings of the organisation (holidays, non-working days, internal controls, date and number formatting, default values, etcetera)
GET /api/settings/general

//get object labels
GET /api/settings/labels
"

Samples responses:

//all organisation's details
{
   "encodedKey":"8a0d41bc4232c78b01425b4993a11d57",
   "name":"Demo",
   "creationDate":"2015-12-15T11:37:57+0000",
   "lastModifiedDate":"2015-12-15T11:37:57+0000",
   "phoneNo":"+442071933870",
   "emailAddress":"hello@mambu.com",
   "timeZoneID":"UTC",
   "address":{
      "encodedKey":"8a80802151a56ad70151a56ebdf30001",
      "parentKey":"8a0d41bc4232c78b01425b4993a11d57",
      "line1":"Jüdentstraße 50",
      "city":"Berlin",
      "region":"Berlin",
      "postcode":"10178",
      "country":"Germany",
      "indexInList":-1
   }
}

//labels for settings
[
   {
      "encodedKey":"8a0a9f9a4bb40498014bb58483a30388",
      "type":"CLIENT",
      "singularValue":"Client",
      "pluralValue":"Clients",
      "language":"ENGLISH",
      "hasCustomValue":false
   },
   {
      "encodedKey":"8a0a9a6d4c7798bb014c7a60861e0aca",
      "type":"GROUP",
      "singularValue":"Company",
      "pluralValue":"Companies",
      "language":"ENGLISH",
      "hasCustomValue":true
   }
]
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete