POST

List Collections


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of data collections and their details.

When collectionIds is empty, all existing collections are returned. If a specified collection does not exist, that collection can be ignored.

Endpoint
POST
{DEPLOYMENT-URI}/v3/collections/get
Body Params
collectionIdsArray <string>

IDs of collections to retrieve. If empty, all available collections are retrieved.

Response Object
collectionsArray <Collection>

List of the retrieved collections.

Request
cURL
curl POST https://external-db.example.com/v3/collections/get \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>' \ --d '{ "collectionIds": [] }'
Response
JSON
{ "collections": [ { "id": "cities", "displayName": "Cities", "fields": [ { "key": "_id", "displayName": "ID", "description": "The ID of the document", "type": "TEXT", "capabilities": { "sortable": true, "queryOperators": ["EQ", "LT", "GT", "LTE", "GTE"] }, "encrypted": false }, { "key": "name", "displayName": "Name", "description": "The name of the city", "type": "TEXT", "capabilities": { "sortable": true, "queryOperators": ["EQ", "STARTS_WITH"] }, "encrypted": false }, { "key": "country", "displayName": "Country", "description": "Country code", "type": "TEXT", "capabilities": { "sortable": true, "queryOperators": ["EQ"] }, "encrypted": false }, { "key": "pointsOfInterest", "displayName": "Points of interest", "type": "MULTI_REFERENCE", "multiReferenceOptions": { "referencedCollectionId": "pointsOfInterest" }, "encrypted": false }, { "key": "_createdDate", "displayName": "Created date", "description": "The date when the document was created", "type": "DATETIME", "capabilities": { "sortable": false, "queryOperators": [] }, "encrypted": false }, { "key": "_updatedDate", "displayName": "Updated date", "description": "The date when the document was last updated", "type": "DATETIME", "capabilities": { "sortable": false, "queryOperators": [] }, "encrypted": false } ], "capabilities": { "dataOperations": ["QUERY", "COUNT"] }, "permissions": { "insert": "ADMIN", "update": "ADMIN", "remove": "ADMIN", "read": "ANYONE" }, "pagingMode": "OFFSET" }, { "id": "pointsOfInterest", "displayName": "Points of interest", "fields": [ { "key": "_id", "displayName": "ID", "description": "The ID of the document", "type": "TEXT", "capabilities": { "sortable": true, "queryOperators": ["EQ", "LT", "GT", "LTE", "GTE"] }, "encrypted": false }, { "key": "name", "displayName": "Name", "description": "The name of the city", "type": "TEXT", "encrypted": false } ], "capabilities": { "dataOperations": ["QUERY", "COUNT"] }, "permissions": { "insert": "ADMIN", "update": "ADMIN", "remove": "ADMIN", "read": "ANYONE" }, "pagingMode": "OFFSET" } ] }
Did this help?