API Object

Contains information about an API.

This object is used by the following operations:

The properties included in the API object are listed below. All values are optional unless otherwise noted.

Property Type Description
APIID string

The unique ID for a specific API.

Required except when adding an API.
Name string The name of the API.
Description string The description of the API. Optional.
Summary string A brief, plain-text description of the API. Optional.
Visibility string The visibility setting for this resource. For a list of valid values, see Visibility Settings.
LatestVersionID string

The unique ID for the latest version of the API.

When the API object is received in a response message, LatestVersionID is ID for the latest version of the API the user is authorized to see, based on the user's status and the API's visibility setting. If the app is Private, the user must be logged in and msut be an API Administrator or API Scope Group member.
Tag string[ ]

One or more user-defined tags assigned to the API, separated by commas. Used only in response messages.

Note: You can also assign specific tags to each API version. In the Community Manager developer portal user interface, only the tags assigned at the API version level are displayed.
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.
RatingSummary RatingSummary An aggregated, averaged summary of individual user ratings for the resource, including the current ratings count for each possible value (1, 2, 3, 4, or 5). Used only in response messages. The API rating summary is an aggregated average of ratings for all API versions.
APIVersion APIVersion

The latest version of the API that the current user is authorized to see:

  • In the addAPI request message: the initial API version that the user is adding.
  • In a response message: the latest version of the API the user is authorized to see, based on the user's status and the API's visibility setting.
PictureID long

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

Used only in request messages when a picture is uploaded as part of adding or updating.
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.
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.
APISettings APISettings Includes information about the settings for an API; for example, whether access is auto approved and whether ratings and reviews are supported.
BusinessID string

The unique ID for a specific business organization on the platform.

Returned if the API is assigned to a business.
TargetResources TargetResources Contains information about one or more resources associated with the current resource. Used only in response messages.
apiOrganizationKey String Organization key for the business organization the API is part of.
InUserTop boolean Indicates whether the API is in included in the user's My Dashboard of top APIs. In response content.