ReferenceFlows API

Variables

Values flows read as $vars.

Method	Path	Summary
GET	`/api/variables`	List variables
POST	`/api/variables`	Create or update a variable
DELETE	`/api/variables/:id`	Delete a variable

#List variables

GET/api/variables

Address: https://<your-org>.brambleit.cloud/flows/api/variables
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Response 200

Field	Type	Description
`variables`	array of any

Example response

JSON

{
  "variables": []
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/variables', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Create or update a variable

POST/api/variables

Address: https://<your-org>.brambleit.cloud/flows/api/variables
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Request body JSON

Name	Type	Description
`id`	integer
`scope`	any
`name`	string
`value`	any

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/variables', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"id":42,"scope":"…","name":"Example name","value":"…"}),
});
const data = await res.json();

#Delete a variable

DELETE/api/variables/:id

Address: https://<your-org>.brambleit.cloud/flows/api/variables/:id
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/variables/42', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

Was this page helpful?