Press CTRL+K to open search

Get a list of spots

  • Published on Aug 7, 2026
Prev Next
Get
/v{version}/Spots

The parameters playerId and locationId are mutually exclusive. If you don't specify both playerId and locationId in the request, all location-specific and player-specific spots are excluded from the result. Spots are implicitly filtered by their spot group read permission.

Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Query parameters
allowVariants
boolean

If true, only spots which allow variant creation are returned. If false, only spots which do not allow variant creation are returned. If you don't specify a value (default), spots are returned regardless of the variant creation setting.

categoryId
array of integer

Unique ID of the category group This parameter represents the category groups, not individual categories. This parameter can accept multiple values. If you specify a value, only spots having all of the given categories are returned. If you don't specify a value (default), spots are returned regardless of categories.

includeCategories
boolean

If true, the property Categories is populated. Default: false.

includeTags
boolean

If true, the property Tags is populated. Default: false.

isTemplate
boolean

If true, only template spots are returned. If false, only non-template spots are returned. If you don't specify a value (default), spots are returned whether they are template spots or not.

locationId
integer (int32)

Unique ID of the location If you specify a value, only spots assigned to the specific location are returned. If you don't specify a value (default), spots are returned regardless of the location ID.

minHeight
integer (int32)

Height of the spot in pixels If you specify a value, only spots having the same height or greater are returned. If you don't specify a value (default), spots are returned regardless of the height.

minWidth
integer (int32)

Width of the spot in pixels If you specify a value, only spots having the same width or greater are returned. If you don't specify a value (default), spots are returned regardless of the width.

name
string

Name of the spot If you specify a value, only spots having the same name (case-insensitive) are returned. If you don't specify a value (default), spots are returned regardless of the name.

playerId
integer (int32)

Unique ID of the player If you specify a value, only spots assigned to the specific player are returned. If you don't specify a value (default), spots are returned regardless of the player ID.

spotGroupId
array of integer

Unique ID of the spot group If you specify a value, only spots assigned to the specific spot group are returned. If you don't specify a value (default), spots are returned regardless of the spot group.

tagId
array of integer

Unique ID of the tag This parameter can accept multiple values. If you specify a value, only spots having all of the given tags are returned. If you don't specify a value (default), spots are returned regardless of tags.

type
string

Type of the spot If you specify a value, only spots having this type are returned. If you don't specify a value (default), spots are returned regardless of the type.

Valid values[ "Default", "Composer", "Trigger", "Ticker", "Url", "OverlayTrigger", "XmlDataSpot", "Audio", "Stream", "Zip", "WebsiteSpot", "HtmlComposerSpot", "WizardSpot", "Font", "WizardSpotMedia", "DashboardWidget", "DashboardWidgetMedia", "Qml", "ComposerPlayer", "RoomManager", "ConvertedSpot", "AscInterface", "AscPlayer" ]
Responses
200

OK

Array of object
object

Spot

ActiveVersion
object (V1.Models.SpotVersion)

Spot version

Duration
integer (int32)

Duration of the spot version in seconds

FileName
string

File name of the spot version

FileVersion
integer (int32)

File version of the spot version

Height
integer (int32)

Height of the spot version in pixels

IsEncrypted
boolean

If true, the spot version is encrypted. Default: false.

Thumbnail
string

Thumbnail states

Valid values[ "NA", "OK", "Outdated" ]
UserCreateDate
string (date-time)

Creation date of the spot version in local player time

Version
integer (int32)

Version of the spot version

VersionId
integer (int32)

Unique ID of the spot version

Width
integer (int32)

Width of the spot version in pixels

AllowArchiving
boolean

If true, the spot allows archiving. Default: false.

AllowVariants
boolean

If true, the spot allows the creation of variants. Default: false.

Categories
Array of object (V1.Models.Spot.SpotCategory)

Categories of the spot

object

Spot's category

Id
integer (int32)

Unique ID of the category

IsDummy
boolean

If true, the category is a dummy category. Default: false.

IsNegated
boolean

If true, the category is a negated category. Default: false.

Created
string (date-time)

Creation date in UTC

Description
string

Description of the spot

DraftVersion
object (V1.Models.SpotVersion)

Spot version

Duration
integer (int32)

Duration of the spot version in seconds

FileName
string

File name of the spot version

FileVersion
integer (int32)

File version of the spot version

Height
integer (int32)

Height of the spot version in pixels

IsEncrypted
boolean

If true, the spot version is encrypted. Default: false.

Thumbnail
string

Thumbnail states

Valid values[ "NA", "OK", "Outdated" ]
UserCreateDate
string (date-time)

Creation date of the spot version in local player time

Version
integer (int32)

Version of the spot version

VersionId
integer (int32)

Unique ID of the spot version

Width
integer (int32)

Width of the spot version in pixels

Id
integer (int32)

Unique ID of the spot

IsArchived
boolean

If true, the spot is archived. Default: false.

IsTemplate
boolean

If true, the spot is a template. Default: false.

Keywords
string

Keywords of the spot

LocationId
integer (int32)

Unique ID of the location

MediaType
string

Media types

Valid values[ "Unknown", "Video", "Flash", "Picture", "PowerPoint", "Pdf", "Shockwave", "Xml", "Mp3", "Html", "EPaper", "Draft", "Zip", "AndroidPackage", "AndroidSkin", "OverlayTrigger", "Qml" ]
Modified
string (date-time)

Modification date in UTC

Name
string

Name of the spot

ParentId
integer (int32)

Unique ID of the parent spot

PlayerId
integer (int32)

Unique ID of the Player assigned to spot

SpotGroupId
integer (int32)

Unique ID of the spot group

Tags
Array of object (V1.Models.Spot.SpotTag)

Tags of the spot

object

Spot's tag

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the tag

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the tag

ParentId
integer (int32)

Unique ID of the tag

Permissions
object

Permissions of the tag

Read
boolean
Write
boolean
Type
string

Tag types

Valid values[ "Standard", "LiveTag", "SyncTag", "ConflictTag", "StartOfCommunication" ]
Type
string

Spot types

Valid values[ "Default", "Composer", "Trigger", "Ticker", "Url", "OverlayTrigger", "XmlDataSpot", "Audio", "Stream", "Zip", "WebsiteSpot", "HtmlComposerSpot", "WizardSpot", "Font", "WizardSpotMedia", "DashboardWidget", "DashboardWidgetMedia", "Qml", "ComposerPlayer", "RoomManager", "ConvertedSpot", "AscInterface", "AscPlayer" ]
ValidFrom
string (date-time)

The spot starts being visible to the player at this date and time.

Example2023-01-25T09:08:03.747Z
ValidTo
string (date-time)

The spot is visible to the player until this date and time.

Example2023-01-25T09:08:03.747Z
VariantCount
integer (int32)

Count of variants

400

Bad Request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
Products
Company
Support
Follow us
© 2025 Grassfish. All Rights Reserved.