Collections

Create a collection inside a folder

post/v1/data/{workspace_id}/collections

Authorizations

Authorizationstringheaderrequired

Use an account access token as Bearer <token>.

Create a folder first, or use an existing folder's @id. Set parents to /<workspace_id>/<folder_id> when creating the collection.

Replace both sample IDs. The folder must exist in the workspace from the request URL and have itemsType: "Collection". parents accepts exactly one path, containing only the workspace and the immediate folder ID, even if that folder is nested. Do not use /collections/ or the full API URL in this value.

Keep itemsType set to the type of your data rows, such as Person; setting it to Collection would create another folder instead. See the Collection object for other fields.

On success, the API returns 201 Created, the new collection's ID, and a Location header. The sample response shows only the created ID.

Use the returned ID to create properties in bulk, then create items. To move an existing collection into a folder, update its parents field using the same path format.

Request

import requests

url = "https://api.datablist.com/v1/data/workspace_example/collections"

headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

payload = {
    "@type": "Collection",
    "label": "Contacts",
    "itemsType": "Person",
    "parents": ["/workspace_example/folder_example"]
}

response = requests.post(url, headers=headers, json=payload)

print(response.text)

Response · illustrative example

{
  "@id": "collection_example"
}