Media Group API

_{Folder & Group Operations}

Create a new media_group

Creates a new media group, which serves as a logical folder to organize uploaded media assets. This is a POST operation that accepts a JSON body defining group metadata such as name and organization ID. The JSON response representing the created media group.

post{hostname}/mediagroup

Body:

{
  "is_public": "true # Type: boolean",
  "name": "Library Receipts # Type: string",
  "organization_id": "432 # Type: integer"
}

API Request Parameters

Name	Type	Required Field	Description
is_public	boolean	True	This property determines if the PUBLIC_URLs of all the media (files) in the media group are accessible without user "authentication" & "authorization"
name	string	True	The name of the media group. This is more like a directory name
organization_id	integer	True	The numeric ID of the of the account

Update existing media_group

Updates an existing media group with new metadata such as name, organization ID, and visibility status. This is a PUT operation that accepts a JSON body and returns the updated media group object in JSON format.

put{hostname}/mediagroup

Body:

{
  "id": "113 # Type: integer",
  "is_public": "true # Type: boolean",
  "name": "Library Receipts # Type: string",
  "organization_id": "24 # Type: integer"
}

API Request Parameters

Name	Type	Required Field	Description
id	integer	True	The numeric ID of the of the Media Group
is_public	boolean	True	This property determines if the PUBLIC_URLs of all the media (files) in the media group are accessible without user "authentication" & "authorization"
name	string	True	The name of the media group. This is more like a directory name
organization_id	integer	True	The numeric ID of the of the account

Get account media_groups

Retrieves all media groups associated with a specified account ID. This is a GET operation. Returns a paginated JSON object containing a list of media groups.

get{hostname}/mediagroup/organization/{organization_id}

Path Query Arguments Example

{hostname}/mediagroup/organization/{organization_id}?page_number=15&page_size=0&sort_ascending=false&sort_by=Jozhan

API Request Parameters

Name	Type	Required Field	Description
organization_id	integer	True	The numeric ID of the of the account
page_number	integer	False	The page number to retrieve (starting from 0). Should be included in the query string. Optional.
page_size	integer	False	The number of records to return per page. For example: 25. Should be included in the query string. Optional.
sort_ascending	boolean	False	Flag indicating the sorted order of the result. True is ascending, while false is descending
sort_by	string	False	Flag indicating the property to which records should be sorted by

Get specified groups of media by group ID

Retrieves details of a media group specified by media_group_id. This is a GET operation. Returns a JSON object with metadata including name, creation time, and organization ID.

get{hostname}/mediagroup/{media_group_id}

API Request Parameters

Name	Type	Required Field	Description
media_group_id	integer	True	The ID of the media group. Type: integer (int64). Must be included in the URL path. Required.

Delete media_group by Id

Deletes the specified media group by its ID. This is a DELETE operation. Returns HTTP 200 or 204 if successful.

delete{hostname}/mediagroup/{media_group_id}

API Request Parameters

Name	Type	Required Field	Description
media_group_id	integer	True	The ID of the media group. Type: integer (int64). Must be included in the URL path. Required.

Get paged media_group content by Id

Retrieves the content within a specified media group, supporting pagination and MIME type filtering. This is a GET operation. The response is a paged JSON array of media objects matching the query filters.

get{hostname}/mediagroup/{media_group_id}/content

Path Query Arguments Example

{hostname}/mediagroup/{media_group_id}/content?file_type=Jozhan&page_number=5&page_size=1&sort_ascending=false&sort_by=Jozhan

API Request Parameters

Name	Type	Required Field	Description
media_group_id	integer	True	The ID of the media group. Type: integer (int64). Must be included in the URL path. Required.
file_type	string	False	The FileType type filter for media (e.g., image, video, document). Type: string. Should be included in the query string. Optional.
page_number	integer	False	The page number to retrieve (starting from 0). Should be included in the query string. Optional.
page_size	integer	False	The number of records to return per page. For example: 25. Should be included in the query string. Optional.
sort_ascending	boolean	False	Flag indicating the sorted order of the result. True is ascending, while false is descending
sort_by	string	False	Flag indicating the property to which records should be sorted by