Get Organization Assets

Get Organization Assets

Introduction 

An API that can be used to fetch assets regardless of their publishing status. Intended to be used by admin users.

Authentication

This API can be accessed by two different authentication methods.

Studio Token

A Studio Token can be provided as a HTTP parameter i.e. &studioToken=some-studio-token When a Studio Token is provided, the organizationId and userId are determined from that.

Authorization headers

A suite user token obtained via the login API can be provided in the request headers as a bearer token. Authorization: Bearer <user-token>

Request 

Path: /api/archive Method: POST

Parameters
Name
Type
Requirement
Description
action
String
Mandatory
getOrganizationAssets
organizationId
Number
Mandatory
Suite Organization ID, NOT Mandatory if using studio token
studioToken
String
optional
Suite Studio token
languageId
String
optional
Language ID, default en_US
groupItemIds
String
Optional
A comma separated list of groupItemIds
keyword
String
Optional
If provided, will only return assets where one of title, description or tags matches the provided keyword.
skip
Number
Optional
Defaults to 0 (Determines how many assets to return)
limit
Number
Optional
Defaults to 100 (Determines how many assets to return)
assetId
Number
Optional
If provided, will only return asset matching the provided assetId.
orderBy
String
Optional("publish-start" or "created"
Orders the assets based on passed parameter




/api/archive?action=getOrganizationAssets&organizationId=12345&groupItemIds=222,333,444&skip=0&limit=10



When you clip an asset using our Clipper tool/API, it is stored as a linked asset to the parent asset.So you can access them ->Asset->linkedAssets->linkedAssets


Example

Getting assets using a Studio Token

  1. curl -i -XGET https\://suite.icareus.com/api/archive\?action\=getOrganizationAssets\&organizationId\=1909009\&skip\=0\&limit\=5\&orderBy\=title\&order\=asc\&studioToken\=Im5mO7UY9XUavML4BQE6S26v\%2BHXR\%2BNOY8K7fFNSeSf9\%2FCfGGpvFGmSbrMa5H7J9K



  1. {
  "total": 2,
  "assets": [
    {
      "coverImageSmall": "",
      "coverImageLarge": "",
      "ingress": "",
      "bannerImageLarge": "",
      "isPublic": false,
      "coverImageMedium": "",
      "id": 4028402,
      "thumbnailSmall": "",
      "description": "",
      "thumbnailMedium": "",
      "name": "hello",
      "thumbnailLarge": "",
      "bannerImageMedium": "",
      "bannerImageSmall": "",
      "programName": ""
    },
    {
      "coverImageSmall": "",
      "coverImageLarge": "",
      "ingress": "",
      "bannerImageLarge": "",
      "isPublic": true,
      "coverImageMedium": "",
      "id": 5029401,
      "thumbnailSmall": "https://suiterc2.icareus.com/image/image_gallery?img_id=5029402",
      "description": "<p>Testing purchase api with this asset</p>",
      "thumbnailMedium": "https://suiterc2.icareus.com/image/image_gallery?img_id=5029403",
      "name": "New Era Test 2",
      "thumbnailLarge": "https://suiterc2.icareus.com/image/image_gallery?img_id=5029404",
      "bannerImageMedium": "",
      "bannerImageSmall": "",
      "programName": ""
    }
  ],
  "status": "ok"
}


Getting assets with a user-token

  1. curl --location 'https://suite.icareus.com/api/archive?action=getOrganizationAssets&organizationId=999877582&skip=50&limit=100&languageId=en_US&orderBy=created&_=1714384643431&assetId=290480735' \
--header 'Authorization: Bearer eyJ0cyI6MTcxNDEyNzIzMTU0NywidXNlcklkIjoyMzg5OTkwNDQsIm9yZ2FuaXphdGlvbklkIjo2ODc3NTgyfQ==.MmMwMDI3NTg2MjUyNjZmYjA2NTQ3NjEyMTQ2MGE0NWU1Mzc4MTVkM2IxMTQ4YzBmGQyZDBhM2VkZWJmZGM3Y2E1YzcwODc5YjNjNTM4NjYzMmI1NDgyZGQ4YTgwN2Y4NGY0ZTIzMzFlYmUyZGQ4YzY2YzBiMjM0ZTFiOTNjYTc='
  1. {
    "total": 1,
    "assets": [
        {
            "coverImageSmall": "",
            "spokenLanguages": "",
            "chapters": {
                "chapters": [
                    {
                        "text": "Test ",
                        "time": 0,
                        "assetId": 291866706
                    }
                ]
            },
            "pageUrl": "",
            "ingress": {},
            "linkedAssets": {
                "linkadAudioAssets": [],
                "linkedImageAssets": [],
                "linkedAssets": [
                    {
                        "coverImageSmall": "",
                        "coverImageLarge": "",
                        "bannerImageLarge": "",
                        "defaultLanguage": "en_US",
                        "coverImageMedium": "",
                        "duration": 13,
                        "assetId": 29186670611,
                        "thumbnailSmall": "https://dvcf59enpgt5y.cloudfront.net/image/image_gallery?img_id=2918672000",
                        "description": {
                            "en_US": "Test"
                        },
                        "thumbnailMedium": "https://dvcf59enpgt5y.cloudfront.net/image/image_gallery?img_id=291867200001",
                        "name": {
                            "en_US": "Test"
                        },
                        "thumbnailLarge": "https://dvcf59enpgt5y.cloudfront.net/image/image_gallery?img_id=291867200001",
                        "bannerImageMedium": "",
                        "bannerImageSmall": ""
                    }
                ]
            },
            "episodeNumber": 0,
            "releaseYear": 0,
            "created": 1713531397000,
            "description": {},
            "thumbnailMedium": "",
            "userAccess": [],
            "groups": "",
            "programName": {},
            "coverImageLarge": "",
            "productionCompany": "",
            "isPublicContentRight": false,
            "bannerImageLarge": "",
            "isPodcastAsset": false,
            "seasonNumber": 0,
            "properties": "",
            "isProtected": false,
            "director": "",
            "coverImageMedium": "",
            "teams": [],
            "podcasts": [],
            "createdBy": 2389990499,
            "externalData": {
                "data": "",
                "label": "",
                "url": ""
            },
            "ownership": "",
            "bannerImageMedium": "",
            "series": [],
            "transcodingStatus": 1,
            "accessControl": {},
            "contentLanguages": [],
            "publishEnd": 2524608000000,
            "folders": [],
            "publishReady": true,
            "contentTypes": [],
            "date": 1713531397000,
            "downloadable": false,
            "publisher": "",
            "id": 290480735,
            "createdByName": "Test user",
            "locations": [],
            "thumbnailSmall": "https://dvcf59enpgt5y.cloudfront.net/image/image_gallery?img_id=2902248280119",
            "name": {
                "en_US": "test3"
            },
            "actors": "",
            "license": "",
            "bannerImageSmall": "",
            "tags": "",
            "files": [],
            "subtitles": [],
            "presets": [
                {
                    "fileId": 290482803,
                    "presetId": 4514326,
                    "description": "512x288@25fps (600kbps) + 128kbps",
                    "name": "512x288@25fps (600kbps) + 128kbps",
                    "dlUrl": "https://d24vi3j4oqssjr.cloudfront.net/10154/226877590/1093902201.mp4/1.0.mp4",
                    "url": ""
                },
                {
                    "fileId": 290482806,
                    "presetId": 85601,
                    "description": "Master preset",
                    "name": "Master",
                    "dlUrl": "https://d24vi3j4oqssjr.cloudfront.net/10154/226877590/1093229002.mp4/1.0.mp4",
                    "url": ""
                },
                {
                    "fileId": 290482812,
                    "presetId": 4514336,
                    "description": "1024x576@25fps (1800kbps) + 128kbps",
                    "name": "1024x576@25fps (1800kbps) + 128kbps",
                    "dlUrl": "https://d24vi3j4oqssjr.cloudfront.net/10154/226877590/10922239003.mp4/1.0.mp4",
                    "url": ""
                },
                {
                    "fileId": 290482815,
                    "presetId": 4514338,
                    "description": "1280x720@25fps (2500kbps) + 128kbps",
                    "name": "1280x720@25fps (2500kbps) + 128kbps",
                    "dlUrl": "https://d24vi3j4oqssjr.cloudfront.net/10154/236877590/10939222004.mp4/1.0.mp4",
                    "url": ""
                }
            ],
            "contentRatings": [],
            "pages": [],
            "defaultLanguage": "en_US",
            "isPublic": true,
            "duration": 63,
            "thumbnailLarge": "https://dvcf59enpgt5y.cloudfront.net/image/image_gallery?img_id=290438222807",
            "groupItemIds": ""
        }
    ],
    "status": "ok"
}



    • Related Articles

    • Sharing Video Assets Between Accounts

      Introduction For customers that have several accounts it is possible to share Assets between the Accounts. The sharing can be done from the parent account to its sub-accounts. Use cases could be e.g. to have company's corporate videos on the parent ...

    • Import Assets from Suite

      Import Assets from Suite Importing assets from Suite is a basic function that enables you to combine several of your videos or to ease the editing of just one. Importing Assets Import is started from Project Media Files by clicking the "Import" ...

    • Recycle Bin API

      Introduction This API allows you to manage the recycle bin. Please note that this API is only meant for managing assets that are already in the recycle bin. If the recycle bin feature is enabled for a an Organizatino, deleting an asset via the ...

    • Youtube - Uploading on-demand videos to YouTube account

      Introduction YouTube is the world's 2nd most used social media service, with 1.9 billion monthly users. YouTube's content volumes are just as staggering. Based on the statistics (2019) every minute YouTube users upload 500 hours of new content to the ...

    • Archive API

      INTRODUCTION This API is used to manage the content within the Archive, actions like add asset, edit asset and delete asset. All calls must be made by supplying the unique token for your organization. API PATH /api/archive API CALLS ADD ASSET V.2 ...