Switchboard Canvas

GET /template/api-name/elements

Returns the elements defined in a given template.

Specify the API name of the template in the GET request path.

Authorization

To authorize your requests to Switchboard Canvas, you'll need your API key. Your API key can be found in the top-right corner on the main Templates page, after you sign in at Switchboard. Add your API key to the Headers collection of your request:

X-API-Key: <your API key>

200 Response

Use the fields array to determine the API names of the elements in your template, and the type field to determine the type of element - either text, image or rectangle.

{
"success": true,
"fields": [
{
"name": "heading",
"type": "text"
},
{
"name": "logo",
"type": "image"
}
]
}

We care about the protection of your data. Read our Privacy Policy.

© 2022 switchboard.ai. All rights reserved.
Privacy Terms Cookies