Get a list of media groups

Prev Next
Get
/v{version}/MediaGroups

Media groups are implicitly filtered by the user's read permission. By default, archived media groups are not returned.

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 media groups are included in the returned list. Default: false.

locationId
integer (int32)

Unique ID of the location

Minimum1.0
Maximum2147483647.0
name
string

Name of the media group

Responses
200
400
403
500

OK

Array of object
object

Media group

AllowArchiving
boolean

If true, the media group allows archiving. Default: false.

AllowMediaArchiving
boolean

If true, the media group allows media archiving. Default: false.

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the media group

IsArchived
boolean

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

LocationId
integer (int32)

Unique ID of the location assigned to the media group

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the media group

ParentId
integer (int32)

Unique ID of the parent media group

Permissions
object

Permissions of the media group

Read
boolean
Write
boolean
Create
boolean
Delete
boolean