Collections

List collections

get

Authorizations

X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters

sortstring · enumOptional

Sort key. Allowed values are createdAt, -createdAt, lastModified, -lastModified, name, -name. Defaults to -createdAt.

Default: -createdAtPossible values:

limitinteger · min: 1 · max: 256Optional

Maximum number of collections to return (1–256). Defaults to 32.

Default: 32

skipinteger · max: 65536Optional

Number of collections to skip (pagination) (0–65536). Defaults to 0.

Default: 0

filter[id]string[]Optional

Collection ID filter. May be repeated and/or provided as a comma‑separated list. Max 512 IDs.

Example: ["4abc234abc234abc2"]

filter[search]string · max: 256Optional

General search string (max 256 chars). Prefix‑matches collection name (case‑insensitive).

Example: Campaign

filter[clientId]stringOptional

Admin‑only. Client ID to filter within (ObjectId).

Example: 7abc234abc234abc2

filter[createdMin]integerOptional

Created at (Unix seconds) lower bound.

Example: 1714521600

filter[createdMax]integerOptional

Created at (Unix seconds) upper bound.

Example: 1717200000

filter[modifiedMin]integerOptional

Last modified (Unix seconds) lower bound.

Example: 1714521600

filter[modifiedMax]integerOptional

Last modified (Unix seconds) upper bound.

Example: 1717200000

filter[favoriteBy]stringOptional

User ID who favorited the collection (ObjectId).

Example: 2abc234abc234abc2

Responses

200

OK

application/json

metaobjectRequired

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

get/v1/collections

GET /api/rest/v1/collections HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {},
  "links": {
    "self": "https://example.com",
    "first": "https://example.com",
    "prev": "https://example.com",
    "next": "https://example.com"
  },
  "data": [
    {
      "type": "collections",
      "id": "text",
      "attributes": {
        "name": "text",
        "createdAt": 1,
        "lastModified": 1,
        "createdBy": "text",
        "lastModifiedBy": "text",
        "clientId": "text",
        "description": "text",
        "thumbnailId": "text",
        "thumbnailDescription": "text",
        "path": "text",
        "relatedIds": [
          "text"
        ],
        "favs": [
          "text"
        ],
        "tags": [
          "text"
        ],
        "status": "text",
        "isPublicCollection": true,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "links": {
        "self": "https://example.com",
        "thumbnail": {
          "href": "https://example.com",
          "meta": {
            "version": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Get collection

get

Authorizations

X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Path parameters

collectionIdstringRequired

Collection ID

Example: 4abc234abc234abc2

Query parameters

filter[clientId]stringOptional

Admin‑only. Client ID to filter within (ObjectId).

Example: 7abc234abc234abc2

Responses

200

OK

application/json

metaobjectOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

get/v1/collections/{collectionId}

GET /api/rest/v1/collections/{collectionId} HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {},
  "links": {
    "self": "https://example.com",
    "thumbnail": {
      "href": "https://example.com",
      "meta": {
        "version": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data": {
    "type": "collections",
    "id": "text",
    "attributes": {
      "name": "text",
      "createdAt": 1,
      "lastModified": 1,
      "createdBy": "text",
      "lastModifiedBy": "text",
      "clientId": "text",
      "description": "text",
      "thumbnailId": "text",
      "thumbnailDescription": "text",
      "path": "text",
      "relatedIds": [
        "text"
      ],
      "favs": [
        "text"
      ],
      "tags": [
        "text"
      ],
      "status": "text",
      "isPublicCollection": true,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "links": {
      "self": "https://example.com",
      "thumbnail": {
        "href": "https://example.com",
        "meta": {
          "version": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}