Sign in

v1

latestOpenAPI 3.1.0Any Source Available License 1.02026-07-1736102200.0 KB
Properties

Create property

Creates a new property in the specified space using a JSON payload. The creation process is subject to rate limiting. The payload must include property details such as the name and format. The endpoint then returns the full property data, ready for further interactions.

post/v1/spaces/{space_id}/properties

Path parameters

space_idstring required

The ID of the space to create the property in; must be retrieved from ListSpaces endpoint

Headers

Anytype-Versionstring required

The version of the API to use

Request body

format'text' | 'number' | 'select' | 'multi_select' | 'date' | 'files' | 'checkbox' | 'url' | 'email' | 'phone' | 'objects' required

The format of the property used for filtering

keystring

The key of the property; should always be snake_case, otherwise it will be converted to snake_case

namestring required

The name of the property

Example request

{
  "key": "some_user_defined_property_key",
  "name": "Last modified date",
  "tags": [
    {
      "color": "yellow",
      "key": "in_progress",
      "name": "In progress"
    }
  ]
}

Response

The created property

Example response

{
  "property": {
    "id": "bafyreids36kpw5ppuwm3ce2p4ezb3ab7cihhkq6yfbwzwpp4mln7rcgw7a",
    "key": "last_modified_date",
    "name": "Last modified date",
    "object": "property"
  }
}