Properties

Endpoint shortcuts

POST/v1/data/:workspace_id/collections/:collection_id/propertiesPOST/v1/data/:workspace_id/collections/:collection_id/properties/batchBULKGET/v1/data/:workspace_id/collections/:collection_id/properties/:property_idPATCH/v1/data/:workspace_id/collections/:collection_id/properties/:property_idPUT/v1/data/:workspace_id/collections/:collection_id/properties/:property_idGET/v1/data/:workspace_id/collections/:collection_id/propertiesDELETE/v1/data/:workspace_id/collections/:collection_id/properties/:property_id

The Property object

json

{
  "@id": "property_first_name",
  "createdAt": "2021-01-08T10:24:26.612030+00:00",
  "updatedAt": "2021-02-15T15:48:18.007428+00:00",
  "@type": "Property",
  "name": "First Name",
  "range": "Text",
  "key": "firstName",
  "unique": false,
  "withIndex": true
}

Properties

Property	Type	Info	Description
@context	object	Optional	JSON-LD context information.
@id	string	Optional	Unique object ID.
createdAt	string	Optional	Creation time as an ISO 8601 timestamp.
updatedAt	string	Read only	Last update time as an ISO 8601 timestamp.
@type	string	Required	Value is "Property"
name	string	Required	Name of the Property.
range	string	Required	Property data type
key	string	Required	Field name used in item data, such as firstName. This is different from the property ID (@id).
description	string or null	Optional	Description of the field, up to 1,000 characters.
rank	string	Optional	A LexoRank string value.
unique	boolean	Optional	When true, the app prevents duplicate values for this property.
withIndex	boolean	Optional	When true, the app can sort by this property.
columnWidth	number	Optional	The column width

Fields not listed above return a bad-request error.

Create a property

Create a property →

Create properties in bulk

Create properties in bulk →

Retrieve a property

Get a property →

Update a property

Partial

Update a property →

Full update

Replace a property →

List all properties

List properties →

Delete a property

Delete a property →