Collections group and filter the site's items. The prefix of the name is its kind: product/ is a top-level product category, grouping/ a filter inside one, service/ a service category, calendar-filter/ a filter on the booking page, blogpost/ a blog category, and so on. Collections can nest and can show their own page.
Endpoints that need a token: the site owner creates it in their admin (Developers > API reference). AI assistants: how to ask the user for one.
10 endpoints.
Get associated collections to another collection.
Public - no token needed.
The ID of the associated group.
Only associated groups with this topic.
Only associated groups with this service.
Only associated groups with this donation topic.
curl -X GET 'http://cloudoffice-gr.max-media.io/associated-groups/{id}?ionic=true&topic=...&service=...&donation-topic=...'{
"name": "Example",
"parent_collection": "6543210fedcba98765432100",
"picture": "6543210fedcba98765432100",
"about_page": "6543210fedcba98765432100",
"match_to_option": false,
"is_color": false,
"color": "#3557c4",
"position": 1,
"items": [
"6543210fedcba98765432101"
],
"thumbnail": "6543210fedcba98765432100",
"_id": "6543210fedcba98765432100"
}Returns the site's collections, newest first unless a sort is given.
Public - no token needed.
Only collections with this type.
Returns a list of Collection objects.
curl -X GET 'http://cloudoffice-gr.max-media.io/collections?ionic=true&type=...'
[
{
"name": "Example",
"parent_collection": "6543210fedcba98765432100",
"picture": "6543210fedcba98765432100",
"about_page": "6543210fedcba98765432100",
"match_to_option": false,
"is_color": false,
"color": "#3557c4",
"position": 1,
"items": [
"6543210fedcba98765432101"
],
"thumbnail": "6543210fedcba98765432100",
"_id": "6543210fedcba98765432100"
}
]Create new collection.
Needs a site admin token.
The collection's create nav.
Returns the Collection object.
curl -X POST 'http://cloudoffice-gr.max-media.io/collections?ionic=true' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'Content-Type: application/json' \
-d '{ "createNav": "..." }'{
"name": "Example",
"parent_collection": "6543210fedcba98765432100",
"picture": "6543210fedcba98765432100",
"about_page": "6543210fedcba98765432100",
"match_to_option": false,
"is_color": false,
"color": "#3557c4",
"position": 1,
"items": [
"6543210fedcba98765432101"
],
"thumbnail": "6543210fedcba98765432100",
"_id": "6543210fedcba98765432100"
}Persist a new display order for a set of collections.
Needs a site admin token.
The collection's items.
curl -X PATCH 'http://cloudoffice-gr.max-media.io/collections-reorder?ionic=true' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'Content-Type: application/json' \
-d '{ "items": "..." }'Returns one collection, found by its ID.
Public - no token needed.
The ID of the collection.
Returns the Collection object.
curl -X GET 'http://cloudoffice-gr.max-media.io/collections/{id}?ionic=true'{
"name": "Example",
"parent_collection": "6543210fedcba98765432100",
"picture": "6543210fedcba98765432100",
"about_page": "6543210fedcba98765432100",
"match_to_option": false,
"is_color": false,
"color": "#3557c4",
"position": 1,
"items": [
"6543210fedcba98765432101"
],
"thumbnail": "6543210fedcba98765432100",
"_id": "6543210fedcba98765432100"
}Update Collection by id.
Needs a site admin token.
The ID of the collection.
Returns the Collection object.
curl -X PATCH 'http://cloudoffice-gr.max-media.io/collections/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"name": "Example",
"parent_collection": "6543210fedcba98765432100",
"picture": "6543210fedcba98765432100",
"about_page": "6543210fedcba98765432100",
"match_to_option": false,
"is_color": false,
"color": "#3557c4",
"position": 1,
"items": [
"6543210fedcba98765432101"
],
"thumbnail": "6543210fedcba98765432100",
"_id": "6543210fedcba98765432100"
}Delete Collection record by id.
Needs a site admin token.
The ID of the collection.
Returns an empty answer on success.
curl -X DELETE 'http://cloudoffice-gr.max-media.io/collections/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'Returns one collection, found by its ID.
Public - no token needed.
The ID of the collection.
Returns the Collection object.
curl -X GET 'http://cloudoffice-gr.max-media.io/collections/{id}/media?ionic=true'{
"name": "Example",
"parent_collection": "6543210fedcba98765432100",
"picture": "6543210fedcba98765432100",
"about_page": "6543210fedcba98765432100",
"match_to_option": false,
"is_color": false,
"color": "#3557c4",
"position": 1,
"items": [
"6543210fedcba98765432101"
],
"thumbnail": "6543210fedcba98765432100",
"_id": "6543210fedcba98765432100"
}Creates a collection from the fields sent.
Needs a site admin token.
The ID of the collection.
curl -X POST 'http://cloudoffice-gr.max-media.io/collections/{id}/media?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'Deletes the collection. This cannot be undone.
Needs a site admin token.
The ID of the collection.
Returns an empty answer on success.
curl -X DELETE 'http://cloudoffice-gr.max-media.io/collections/{id}/media?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'