Endpoint:

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

Returns an element.

The element_id must belong to the property, which is set by property_id and the api_key parameter.

Each element in the collection will have at least the following attributes:

  • id: Can be used for targeting an element specifically.
  • template_name: The name of the element's template.
  • title: Gets set by the primary field for that element's template.
  • slug: A URL-friendly string generated from the title when the element is created.
  • created_at and updated_at: Date references for the element.

In addition, any fields available on the elements template will be included in the response.

If the field is an of the element(s) type, then the response will include the JSON response for the associated element.

Response:

{
    "body": "Welcome to Sapwood's documentation! ...",
    "created_at": "2016-12-09T14:44:39.990Z",
    "description": "Welcome to Sapwood! ...",
    "id": 1,
    "name": "Overview",
    "position": "1",
    "slug": "overview",
    "template_name": "Documentation:Guide",
    "title": "Overview",
    "updated_at": "2016-12-10T16:57:37.807Z"
}

Required Parameters:

api_key

The element's property's API key.

Optional Parameters:

includes (Default: nil)

Include associations in the response. Note that direct associations will be returned automatically, but indirect associations must be specified.

If you wish to include more than one association they should be comma-separated.