Properties

Creating an property

Endpoint

POST /v1/properties

Parameters

Name Description
name required Name
euid required External UID (must be unique)

Request

curl "https://capi.storyblok.com/v1/properties" -d '{"name":"Property","euid":"test13011"}' -X POST \
	-H "Accept: application/json" \
	-H "Content-Type: application/json"
	-H "Authorization: Token token=43608bdfcbff6cd17f5c267917bd57e9" \

Response

{
  "id": 29932,
  "name": "Property",
  "slug": "test13011",
  "technical_slug": null,
  "images": "",
  "parent_id": null,
  "euid": "test13011",
  "seo_title": "",
  "seo_description": "",
  "seo_keywords": "",
  "start_date": null,
  "end_date": null,
  "excerpt": "",
  "description": ""
}

Deleting a property

Endpoint

DELETE /v1/properties/:id

Request

curl "https://capi.storyblok.com/v1/properties/29936" -d '' -X DELETE \
	-H "Accept: application/json" \
	-H "Content-Type: application/json"
	-H "Authorization: Token token=0a14ce4c68c2dbc7012728647fe2d185" \

Getting a list of properties

Endpoint

GET /v1/properties

Parameters

Name Description
page Current page of properties
slug Slug of category
parent_id Parent id
only_active Filter properties that are within start_date and end_date
as_tree Get as tree

Request

Query Parameters

page=1
curl "https://capi.storyblok.com/v1/properties?page=1" -X GET \
	-H "Accept: application/json" \
	-H "Content-Type: application/json"
	-H "Authorization: Token token=1d6ab320e03d9cf159de566fe36c3da4" \

Response

[

]

Updating a property

Endpoint

PUT /v1/properties/:id

Parameters

Name Description
name required Name of property

Request

curl "https://capi.storyblok.com/v1/properties/29934" -d '{"name":"Blue Property"}' -X PUT \
	-H "Accept: application/json" \
	-H "Content-Type: application/json"
	-H "Authorization: Token token=13010f007cb46c373a7a81df356d68a6" \

Response

{
  "id": 29934,
  "name": "Blue Property",
  "slug": "test32452",
  "technical_slug": "",
  "images": "",
  "parent_id": 0,
  "euid": "test32452",
  "seo_title": "",
  "seo_description": "",
  "seo_keywords": "",
  "start_date": null,
  "end_date": null,
  "excerpt": "",
  "description": ""
}