Business Object

Contains information about a business on the platform.

This object is used by the following operations:

The properties included in the Business object are listed below.

Property Type Description
BusinessID string The unique ID for a specific business organization on the platform.
BusinessKey string The unique ID used in the underlying infrastructure to identify a specific business organization.
Name string The name of the business.
Description string The description of the business.
Link anyURI A link for the resource, if applicable.
Contact string Contact information for the resource, if applicable.
Visibility string The visibility setting for this resource. For a list of valid values, see Visibility Settings.
Picture anyURI A link to an image for the resource, if applicable.
IsFollowed boolean

Indicates whether the user invoking the operation has a relationship with the resource:

  • False: an anonymous user is requesting the resource
  • True: the user has a relationship with the resource; for example, the user is an Administrator for the resource.

Only present when this object is used in a response message.
PictureID long

The unique Dropbox ID for the picture uploaded for the resource, if applicable.

Used only in request messages when a picture is uploaded as part of adding or updating.
Created dateTime The date/time stamp when the resource was first created. Used only in response messages.
Updated dateTime The date/time stamp when the resource was last updated. Used only in response messages.
AvatarURL anyURI URL for the avatar uploaded for the resource, if any. Used only in response messages.
AdminGroupID string The unique ID for the Admin Group associated with a specific resource, such as an API or business, comprised of all administrators associated with that resource. Only used in response messages.
BusinessType string

The name for the type of business; for example, Company, Department, Partner. For valid values, see BusinessType values.

Optional.
BusinessAPISettings BusinessAPISettings Contains information about the settings to apply to all APIs within the business, unless specified otherwise at a lower level.
BusinessAppSettings BusinessAppSettings Default settings to apply to all apps within the business, unless specified otherwise at a lower level.
BusinessGroupSettings BusinessGroupSettings Default settings to apply to all groups within the business, unless specified otherwise at a lower level.
BusinessUserSettings BusinessUserSettings Default settings to apply to all users within the business.
BusinessAdminMemberWorkflowDefKey string The unique workflow definition key for the custom workflow for the resource, if a custom workflow for this resource type is in use.
TicketSettings TicketSettings Contains information about a business's settings in relation to tickets.
AlertSettings AlertSettings Contains information about the alert settings for the business.
ConnectionSettings ConnectionSettings Contains information about a business's settings in relation to connections (app/API contracts).
BusinessReviewSettings BusinessReviewSettings Contains information about default settings to apply to all reviews within the business.
BusinessDiscussionSettings BusinessDiscussionSettings Contains information about default settings to apply to all discussions within the business.
CommentSettings CommentSettings Contains information about default settings to apply to all comments within the business.
Settings Settings Contains information about general settings for a business, such as maximum image upload size.
ParentBusinessID string The unique BusinessID for the parent organization (senior in the organization hierarchy) of a business organization on the platform.
TargetResources TargetResources Contains information about one or more resources associated with the current resource. Used only in response messages.