Responses

• • 200

  OK

  Hide response attributes Show response attributes object

  • name string
  • address string
  • currency string
  • currency_symbol string
  • date_format string
  • timezone 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
    Hide app attribute Show app attribute

    • dashboard object
      Hide dashboard attribute Show dashboard attribute

      • items array[object]
        Hide items attributes Show items attributes

        • 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
  • contact object

    The data to show on the contact page on the app

    Hide contact attributes Show contact attributes

    • enabled number

      Whether the contact enabled or not

      Values are 1 or 0.

    • data object
      Hide data attributes Show data attributes

      • 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