Get a list of spot groups

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/SpotGroups

By default, only the default spot groups are returned. Spot groups are implicitly filtered by the user's read permission.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Default"1.18"
Query parameters
includeArchived
boolean

If true, archived spot groups are included. Default: false.

includeTemplateGroups
boolean

If true, template spot groups are included. Default: false.

locationId
integer (int32)

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

name
string

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

Responses
200

OK

Array of object
object

Spot group

AllowArchiving
boolean

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

AllowSpotArchiving
boolean

If true, the spot group allows automatic archiving of spot. Default: false.

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the spot group

IsArchived
boolean

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

IsTemplateGroup
boolean

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

LocationId
integer (int32)

Unique ID of the location of the spot group

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the spot group

ParentId
integer (int32)

Unique ID of the parent of the spot group

Permissions
object

Permissions of the spot group

Read
boolean
Write
boolean
Create
boolean
Delete
boolean
EditTemplate
boolean
VideoExport
boolean
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
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