New Asset Group Endpoint

• Dan Beghin

Version 1.0 of the Widen Collective® API has long had the ability to return information about asset groups in your Collective app. This same asset group information is now being returned in version 2.0. Custom integrations use asset group endpoints to help organize and permission assets.

The following endpoint is now available for use in v2.0 of the API:

  • GET /v2/assets/assetgroups

This endpoint is functionally identical to the /api/rest/assetgroups endpoint in v1.0, but now has added reliability and durability to ensure integrations will get accurate information.

Migration

If an integration is already using the endpoint in v1.0, then a simple migration should be performed. To do that:

  1. Change the endpoint from https://mysite.widencollective.com/api/rest/assetgroups to https://api.widencollective.com/v2/assets/assetgroups.
  2. Change the response data field from assetGroups to items. See examples below:

Examples

v1.0 response shape:

{
  "assetGroups": [
    {
      "uuid": "f4aed450-886f-469f-9e8e-5bd5768216c3",
      "name": "Guest Pass Uploads"
    },
    {
      "uuid": "a4e15933-a240-4a6b-8e61-e876148feb4a",
      "name": "mobile"
    }
  ]
}

v2.0 response shape:

{
  "item_type": "assetgroup",
  "total_count": 2,
  "items": [
    {
      "uuid": "f4aed450-886f-469f-9e8e-5bd5768216c3",
      "name": "Guest Pass Uploads"
    },
    {
      "uuid": "a4e15933-a240-4a6b-8e61-e876148feb4a",
      "name": "mobile"
    }
  ]
}

An in-depth look is available in our API documentation. Please don’t hesitate to reach out to our Support team with any questions.