Business

This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see the Unified business identity preview for more details.

Note: The GraphQL resources under preview cannot be accessed via the Explorer at this time.

A group of one or more organizations with consolidated billing.

Implements

Connections

organizations (OrganizationConnection!)

A list of organizations that belong to this business.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.
before String

Returns the elements in the list that come before the specified cursor.
first Int

Returns the first n elements from the list.
last Int

Returns the last n elements from the list.
orderBy OrganizationOrder

Ordering options for organizations returned from the connection.

The default value is {"field"=>"LOGIN", "direction"=>"ASC"}.

Fields

adminInfo (BusinessAdminInfo)

Business information only visible to admins

avatarUrl (URI!)

A URL pointing to the business's public avatar.

Argument Type Description
size Int

The size of the resulting square image.
billingInfo (BusinessBillingInfo)

Business billing information visible to billing managers

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The description of the business

descriptionHTML (HTML!)

The description of the business as HTML.

id (ID!)
location (String)

The location of the business

name (String!)

The name of the business

resourcePath (URI!)

The HTTP path for this business.

url (URI!)

The HTTP URL for this business.

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this business?

websiteUrl (URI)

The URL for the business's website