Retrieve the configuration of the site

GET /global/site

This returns the list of details of the site along with the setup of the app details

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • name string
    • address string
    • currency string
    • currency_symbol string
    • date_format string
    • timezone string
    • country_code string
    • household_word string

      Whether to show the word household or organisation when describing the household

      Values are organisation or household.

    • site_secret string
    • backgroundUmageUrl string

      The full URL of the image to show on the background of the app. The URL will always be an https

    • app object

      Additional properties are allowed.

      Hide app attributes Show app attributes object
      • dashboard object

        Additional properties are allowed.

        Hide dashboard attribute Show dashboard attribute object
        • items array[object]
          Hide items attributes Show items attributes object
          • showAs string

            Values are image, text, header, or fullWidthImage.

          • linkToType string

            Values are myroster, calendar, directory, or todaysEvent.

          • pageTitle string
          • permission array[string]

            Values are authenticated or public.

          • imageUrl string
      • homePageColumns integer

        Number of columns to show on the home page, either 1 or 2 is allowed

    • contact object

      The data to show on the contact page on the app

      Additional properties are allowed.

      Hide contact attributes Show contact attributes object
      • enabled number

        Whether the contact enabled or not

        Values are 1 or 0.

      • data object

        Additional properties are allowed.

        Hide data attributes Show data attributes object
        • organisationName string

          Optional. The public name of the organisation

        • contactPhoneLabel1 string

          Optional. A label for the phone number

        • contactPhoneNumber1 string

          Optional. A phone number

        • contactPhoneLabel2 string

          Optional. A label for the alternative number

        • contactPhoneNumber2 string

          Optional. An alternate phone number

        • contactEmailLabel1 string

          Optional. A label to describe the email address

        • contactEmailAddress1 string

          Optional. An email address

        • contactEmailLabel2 string

          Optional. A label to describe the alternate email address

        • contactEmailAddress2 string

          Optional. An alternate address

        • physicalAddressLabel1 string

          Optional. A label to describe the 1st address

        • physicalAddress1 string

          Optional. An address for the organisation

        • physicalAddressLabel2 string

          Optional. A label to describe the 2nd address

        • physicalAddress2 string

          Optional. An alternative address

        • privacyPolicyUrl string

          Optional. A link to the privacy policy

GET /global/site
curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/global/site' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "name": "Test Organisation",
  "address": "1 High Street, Tauranga, New Zealand",
  "currency": "NZD",
  "currency_symbol": "$",
  "date_format": "j M Y",
  "timezone": "Pacific/Auckland",
  "country_code": "US",
  "household_word": "household",
  "site_secret": "string",
  "backgroundUmageUrl": "https://www.google.com/image.png",
  "app": {
    "dashboard": {
      "items": [
        {
          "showAs": "image",
          "linkToType": "webview",
          "pageTitle": "Link to our website",
          "permission": [
            "public"
          ],
          "imageUrl": "https://www.google.com/image.png"
        }
      ]
    },
    "homePageColumns": 1
  },
  "contact": {
    "enabled": 1,
    "data": {
      "organisationName": "Test Organisation",
      "contactPhoneLabel1": "Office",
      "contactPhoneNumber1": "07 578 3085",
      "contactPhoneLabel2": "Support",
      "contactPhoneNumber2": "07 123 1234",
      "contactEmailLabel1": "Sales",
      "contactEmailAddress1": "sales@infoodle.com",
      "contactEmailLabel2": "Support",
      "contactEmailAddress2": "support@infoodle.com",
      "physicalAddressLabel1": "NZ HQ",
      "physicalAddress1": "5d Owens Place, Bayfair, New Zealand",
      "physicalAddressLabel2": "UK Office",
      "physicalAddress2": "1 High Street, Berkshire, England",
      "privacyPolicyUrl": "https://www.google.com/privacy.html"
    }
  }
}