Endpoint:

GET /api/v1/properties/[property_id].json

Returns the basic information about a property, including its configuration.

Response:

{
    "api_key": "a3b3904a2302d929958bc4fdbaba757b60787b1b9a6fc4749c",
    "color": "#63C2C2",
    "created_at": "2016-11-09T18:11:26.656Z",
    "id": 1,
    "templates_raw": "[{\"title\":\"Documentation:Guide\",\"menu_label\":\"Documentation\",\"order\":{\"by\":\"position\"},\"fields\":{\"name\":{\"primary\":true},\"description\":{\"type\":\"text\"},\"body\":{\"type\":\"text\"},\"position\":{}}},{\"title\":\"API:Guide\",\"namespace\":\"API\",\"menu_label\":\"Guides\",\"order\":{\"by\":\"position\"},\"fields\":{\"name\":{\"primary\":true},\"description\":{\"type\":\"text\"},\"body\":{\"type\":\"text\"},\"position\":{}}},{\"title\":\"API:Request\",\"namespace\":\"API\",\"menu_label\":\"Requests\",\"order\":{\"by\":\"position\"},\"associations\":{\"options\":{\"template\":\"API:Option\",\"field\":\"request\"}},\"fields\":{\"name\":{\"primary\":true},\"path\":{},\"response\":{\"type\":\"text\"},\"description\":{\"type\":\"text\"},\"method_type\":{\"type\":\"select\",\"options\":[\"GET\",\"POST\",\"PUT\",\"DELETE\"],\"label\":\"Method\"},\"position\":{}}},{\"title\":\"API:Option\",\"namespace\":\"API\",\"menu_label\":\"Options\",\"fields\":{\"name\":{\"primary\":true},\"description\":{\"type\":\"text\"},\"request\":{\"type\":\"element\",\"templates\":[\"API:Request\"]}}},{\"title\":\"API:Example\",\"namespace\":\"API\",\"menu_label\":\"Examples\",\"fields\":{\"name\":{\"primary\":true},\"description\":{\"type\":\"text\"},\"body\":{\"type\":\"text\"}}},{\"title\":\"Config:Guide\",\"namespace\":\"Config\",\"menu_label\":\"Guides\",\"order\":{\"by\":\"position\"},\"fields\":{\"name\":{\"primary\":true},\"description\":{\"type\":\"text\"},\"body\":{\"type\":\"text\"},\"position\":{}}},{\"title\":\"Config:Option\",\"namespace\":\"Config\",\"menu_label\":\"Options\",\"associations\":{\"children\":{\"template\":\"Config:Option\",\"field\":\"parent\"}},\"fields\":{\"name\":{\"primary\":true},\"description\":{\"type\":\"text\"},\"parent\":{\"type\":\"element\",\"templates\":[\"Config:Option\"]}}},{\"title\":\"Config:Example\",\"namespace\":\"Config\",\"menu_label\":\"Examples\",\"fields\":{\"name\":{\"primary\":true},\"description\":{\"type\":\"text\"},\"body\":{\"type\":\"text\"}}},{\"title\":\"Support\",\"menu_label\":\"Support\",\"fields\":{\"name\":{\"primary\":true},\"description\":{\"type\":\"text\"},\"body\":{\"type\":\"text\"}}},{\"title\":\"Feature\",\"fields\":{\"name\":{\"primary\":true},\"body\":{\"type\":\"text\"},\"image\":{\"type\":\"element\",\"templates\":[\"Image\"]}}},{\"title\":\"Team Member\",\"fields\":{\"name\":{\"primary\":true},\"role\":{},\"headshot\":{\"type\":\"element\",\"templates\":[\"Image\"]},\"description\":{\"type\":\"text\"},\"website_url\":{},\"twitter_url\":{},\"github_url\":{}}},{\"title\":\"Image\",\"type\":\"document\",\"fields\":{\"name\":{\"primary\":true}}}]",
    "title": "Sapwood",
    "updated_at": "2016-12-10T19:11:34.374Z"
}

Required Parameters:

api_key

The API key of the property.