ReferenceForms API

Images

Images used in forms.

Method	Path	Summary
POST	`/v1/app/forms/images`	Upload a theme background/banner image (multipart, field "image")
GET	`/v1/app/forms/images/:id`	Public, no auth (theme images embedded via <img>/CSS background-image)

#Upload a theme background/banner image (multipart, field "image")

POST/v1/app/forms/images

Address: https://<your-org>.brambleit.cloud/api/v1/app/forms/images
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Forms.

Request body

multipart/form-data with the file.

Response 201

Field	Type	Description
`id`	integer
`url`	string

Example response

JSON

{
  "id": 42,
  "url": "https://example.com/…"
}

Errors

Status	Message
400	No image file provided

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/api/v1/app/forms/images' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/forms/images', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/api/v1/app/forms/images",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/forms/images' -Headers $headers

#Public, no auth (theme images embedded via <img>/CSS background-image)

GET/v1/app/forms/images/:id

Address: https://<your-org>.brambleit.cloud/api/v1/app/forms/images/:id
Requires: None: public, or protected by a token in the address or body.

Path parameters

Name	Type	Description
`id`required	integer

Response

A body.

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/app/forms/images/42' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/forms/images/42', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/app/forms/images/42",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/forms/images/42' -Headers $headers

Was this page helpful?