Collections

List collections tree

Retrieve the collection hierarchy for the current tenant. Supports depth limiting and pagination.

get/api/v1/collections

Request

  • Base URL: https://numonic.ai
  • URL: https://numonic.ai/api/v1/collections
  • Auth: API key in header x-api-key

Query parameters

parentPathstring
depthnumber
includeAssetCountsstring
limitnumber
offsetnumber nullable

Headers

X-Tenant-IDstring uuid

Target tenant UUID. Required when API key has access to multiple tenants.

Example:fd32351e-ddfc-4800-9182-cb16e0bc5f5b

Response

Collection tree retrieved successfully

totalinteger required
limitinteger required
offsetinteger required

Example response

{
  "collections": [
    {
      "collection_path": "projects.nike"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.