Banner

Banner returned for app-authenticated requests. Requires scope: banner.list (list) or banner.read (single).

address1string

Primary address line

address2string

Secondary address line

companystring

The company or organization name associated with the banner

emailsstring[]

The list of email addresses for contact purposes

fullnamestring

The full name of the banner owner or contact person

idstring

Banner ID

ownerIdstring

ID of the banner owner

phones object[]

The list of phone numbers for contact purposes

Array [

labelstring

numberstring

]

settings object

Banner settings. Only populated when reading a single banner.

editors object

Editor users and groups

groupsstring[]

List of group public IDs

usersstring[]

List of user public IDs

viewAttrs object

View attributes such as color scheme

property name*any

View attributes such as color scheme

viewProtection object

Viewer users and groups for view protection

groupsstring[]

List of group public IDs

usersstring[]

List of user public IDs

social object[]

List of social media profile URLs

Array [

labelstring

linkstring

]

titlestring

The job title or position of the banner owner

websitestring

The primary website URL

Banner

{
  "address1": "string",
  "address2": "string",
  "company": "string",
  "emails": [
    "string"
  ],
  "fullname": "string",
  "id": "string",
  "ownerId": "string",
  "phones": [
    {
      "label": "string",
      "number": "string"
    }
  ],
  "settings": {
    "editors": {
      "groups": [
        "string"
      ],
      "users": [
        "string"
      ]
    },
    "viewAttrs": {},
    "viewProtection": {
      "groups": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "social": [
    {
      "label": "string",
      "link": "string"
    }
  ],
  "title": "string",
  "website": "string"
}