{
 "generated": "2026-11-13",
 "routes": [
  {
   "section": "hub",
   "resource": "profile",
   "method": "GET",
   "path": "/v1/user",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user",
   "summary": "Get your account",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/profile#get-v1-user"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "GET",
   "path": "/v1/user/2fa",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/2fa",
   "summary": "Is two-step sign-in on?",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/security#get-v1-user-2fa"
  },
  {
   "section": "hub",
   "resource": "profile",
   "method": "GET",
   "path": "/v1/user/email",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/email",
   "summary": "Get your email address",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/profile#get-v1-user-email"
  },
  {
   "section": "hub",
   "resource": "profile",
   "method": "GET",
   "path": "/v1/user/picture",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/picture",
   "summary": "Get your photo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/profile#get-v1-user-picture"
  },
  {
   "section": "hub",
   "resource": "profile",
   "method": "PUT",
   "path": "/v1/user/picture",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/picture",
   "summary": "Set your photo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "image",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/profile#put-v1-user-picture"
  },
  {
   "section": "hub",
   "resource": "profile",
   "method": "DELETE",
   "path": "/v1/user/picture",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/picture",
   "summary": "Remove your photo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/profile#delete-v1-user-picture"
  },
  {
   "section": "hub",
   "resource": "sessions",
   "method": "GET",
   "path": "/v1/user/login_history",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/login_history",
   "summary": "Your last 15 sign-ins",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sessions#get-v1-user-login-history"
  },
  {
   "section": "hub",
   "resource": "sessions",
   "method": "GET",
   "path": "/v1/user/login_history/month",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/login_history/month",
   "summary": "Your sign-ins in the last month",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sessions#get-v1-user-login-history-month"
  },
  {
   "section": "hub",
   "resource": "sessions",
   "method": "GET",
   "path": "/v1/user/sessions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/sessions",
   "summary": "Where you're signed in",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sessions#get-v1-user-sessions"
  },
  {
   "section": "hub",
   "resource": "sessions",
   "method": "POST",
   "path": "/v1/user/sessions/revoke",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/sessions/revoke",
   "summary": "Sign out one session",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "session_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/sessions#post-v1-user-sessions-revoke"
  },
  {
   "section": "hub",
   "resource": "sessions",
   "method": "POST",
   "path": "/v1/user/sessions/revoke_all",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/sessions/revoke_all",
   "summary": "Sign out everywhere",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sessions#post-v1-user-sessions-revoke-all"
  },
  {
   "section": "hub",
   "resource": "pins",
   "method": "GET",
   "path": "/v1/user/faq/:service",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/faq/:service",
   "summary": "Help articles for an app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "service"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/pins#get-v1-user-faq-service"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "POST",
   "path": "/v1/user/2fa/disable",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/2fa/disable",
   "summary": "Switch off two-step sign-in",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/security#post-v1-user-2fa-disable"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "POST",
   "path": "/v1/user/2fa/verify",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/2fa/verify",
   "summary": "Switch on two-step sign-in",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "verify_code_input",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/hub/security#post-v1-user-2fa-verify"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "POST",
   "path": "/v1/user/2fa/generate",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/2fa/generate",
   "summary": "Start setting up two-step sign-in",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/security#post-v1-user-2fa-generate"
  },
  {
   "section": "hub",
   "resource": "app-passwords",
   "method": "GET",
   "path": "/v1/user/app-passwords",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/app-passwords",
   "summary": "List your app passwords",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/app-passwords#get-v1-user-app-passwords"
  },
  {
   "section": "hub",
   "resource": "app-passwords",
   "method": "POST",
   "path": "/v1/user/app-passwords",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/app-passwords",
   "summary": "Create an app password",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/app-passwords#post-v1-user-app-passwords"
  },
  {
   "section": "hub",
   "resource": "app-passwords",
   "method": "DELETE",
   "path": "/v1/user/app-passwords/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/app-passwords/:id",
   "summary": "Revoke an app password",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/app-passwords#delete-v1-user-app-passwords-id"
  },
  {
   "section": "hub",
   "resource": "notifications",
   "method": "GET",
   "path": "/v1/user/notifications",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/notifications",
   "summary": "List your notifications",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/hub/notifications#get-v1-user-notifications"
  },
  {
   "section": "hub",
   "resource": "notifications",
   "method": "POST",
   "path": "/v1/user/notifications/read",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/notifications/read",
   "summary": "Mark notifications read",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "all",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/notifications#post-v1-user-notifications-read"
  },
  {
   "section": "hub",
   "resource": "notifications",
   "method": "GET",
   "path": "/v1/user/push/key",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/push/key",
   "summary": "Get the Web Push public key",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/notifications#get-v1-user-push-key"
  },
  {
   "section": "hub",
   "resource": "notifications",
   "method": "POST",
   "path": "/v1/user/push/subscribe",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/push/subscribe",
   "summary": "Register a browser for push notifications",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "subscription",
     "type": "any",
     "required": false
    },
    {
     "name": "scope",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/notifications#post-v1-user-push-subscribe"
  },
  {
   "section": "hub",
   "resource": "notifications",
   "method": "POST",
   "path": "/v1/user/push/unsubscribe",
   "url": "https://<your-org>.brambleit.cloud/api/v1/user/push/unsubscribe",
   "summary": "Stop push notifications to a browser",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "endpoint",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/notifications#post-v1-user-push-unsubscribe"
  },
  {
   "section": "hub",
   "resource": "profile",
   "method": "GET",
   "path": "/user/info",
   "url": "https://<your-org>.brambleit.cloud/api/user/info",
   "summary": "Get your account (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/profile#get-user-info"
  },
  {
   "section": "hub",
   "resource": "profile",
   "method": "GET",
   "path": "/user/name",
   "url": "https://<your-org>.brambleit.cloud/api/user/name",
   "summary": "Get your name (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/profile#get-user-name"
  },
  {
   "section": "hub",
   "resource": "profile",
   "method": "GET",
   "path": "/user/email",
   "url": "https://<your-org>.brambleit.cloud/api/user/email",
   "summary": "Get your email address (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/profile#get-user-email"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "GET",
   "path": "/user/2fa",
   "url": "https://<your-org>.brambleit.cloud/api/user/2fa",
   "summary": "Is two-step sign-in on? (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/security#get-user-2fa"
  },
  {
   "section": "hub",
   "resource": "sessions",
   "method": "GET",
   "path": "/user/login_history",
   "url": "https://<your-org>.brambleit.cloud/api/user/login_history",
   "summary": "Your recent sign-ins (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sessions#get-user-login-history"
  },
  {
   "section": "hub",
   "resource": "sessions",
   "method": "GET",
   "path": "/user/login_history/month",
   "url": "https://<your-org>.brambleit.cloud/api/user/login_history/month",
   "summary": "Your sign-ins in the last month (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sessions#get-user-login-history-month"
  },
  {
   "section": "hub",
   "resource": "profile",
   "method": "GET",
   "path": "/user/picture",
   "url": "https://<your-org>.brambleit.cloud/api/user/picture",
   "summary": "Get your photo (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/profile#get-user-picture"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "POST",
   "path": "/user/2fa/generate",
   "url": "https://<your-org>.brambleit.cloud/api/user/2fa/generate",
   "summary": "Start setting up two-step sign-in (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/security#post-user-2fa-generate"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "POST",
   "path": "/user/2fa/verify",
   "url": "https://<your-org>.brambleit.cloud/api/user/2fa/verify",
   "summary": "Switch on two-step sign-in (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "verify_code_input",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/security#post-user-2fa-verify"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "POST",
   "path": "/user/2fa/disable",
   "url": "https://<your-org>.brambleit.cloud/api/user/2fa/disable",
   "summary": "Switch off two-step sign-in (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/security#post-user-2fa-disable"
  },
  {
   "section": "hub",
   "resource": "security",
   "method": "POST",
   "path": "/user/password/change",
   "url": "https://<your-org>.brambleit.cloud/api/user/password/change",
   "summary": "Change your password",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "totp_code",
     "type": "any",
     "required": false
    },
    {
     "name": "current_password",
     "type": "any",
     "required": false
    },
    {
     "name": "new_password",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/security#post-user-password-change"
  },
  {
   "section": "hub",
   "resource": "pins",
   "method": "GET",
   "path": "/user/pins",
   "url": "https://<your-org>.brambleit.cloud/api/user/pins",
   "summary": "List your pinned apps",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/pins#get-user-pins"
  },
  {
   "section": "hub",
   "resource": "pins",
   "method": "POST",
   "path": "/user/pins",
   "url": "https://<your-org>.brambleit.cloud/api/user/pins",
   "summary": "Pin an app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "pin_key",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/pins#post-user-pins"
  },
  {
   "section": "hub",
   "resource": "pins",
   "method": "DELETE",
   "path": "/user/pins/:pin_key",
   "url": "https://<your-org>.brambleit.cloud/api/user/pins/:pin_key",
   "summary": "Unpin an app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "pin_key"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/pins#delete-user-pins-pin-key"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "GET",
   "path": "/v1/tenant/info",
   "url": "https://<your-org>.brambleit.cloud/api/v1/tenant/info",
   "summary": "Get your organisation",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/organisation#get-v1-tenant-info"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "GET",
   "path": "/v1/tenant/licenses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/tenant/licenses",
   "summary": "Your organisation's licences",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/organisation#get-v1-tenant-licenses"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "POST",
   "path": "/v1/tenant/check-license",
   "url": "https://<your-org>.brambleit.cloud/api/v1/tenant/check-license",
   "summary": "Is the organisation licensed for an app?",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "application_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/organisation#post-v1-tenant-check-license"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "GET",
   "path": "/v1/tenant/users",
   "url": "https://<your-org>.brambleit.cloud/api/v1/tenant/users",
   "summary": "People in your organisation",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/organisation#get-v1-tenant-users"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "GET",
   "path": "/v1/tenant/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/tenant/groups",
   "summary": "Groups in your organisation",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/organisation#get-v1-tenant-groups"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "POST",
   "path": "/v1/tenant/groups/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/tenant/groups/members",
   "summary": "Members of a group",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "group_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/hub/organisation#post-v1-tenant-groups-members"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "GET",
   "path": "/v1/tenant/domains",
   "url": "https://<your-org>.brambleit.cloud/api/v1/tenant/domains",
   "summary": "Your organisation's domains",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/organisation#get-v1-tenant-domains"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "GET",
   "path": "/tenant/info",
   "url": "https://<your-org>.brambleit.cloud/api/tenant/info",
   "summary": "Get your organisation (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/organisation#get-tenant-info"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "GET",
   "path": "/tenant/licenses",
   "url": "https://<your-org>.brambleit.cloud/api/tenant/licenses",
   "summary": "Your organisation's licences (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/organisation#get-tenant-licenses"
  },
  {
   "section": "hub",
   "resource": "organisation",
   "method": "POST",
   "path": "/tenant/check-license",
   "url": "https://<your-org>.brambleit.cloud/api/tenant/check-license",
   "summary": "Is the organisation licensed for an app? (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "application_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/organisation#post-tenant-check-license"
  },
  {
   "section": "hub",
   "resource": "search",
   "method": "GET",
   "path": "/v1/search",
   "url": "https://<your-org>.brambleit.cloud/api/v1/search",
   "summary": "Search",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [
    "q",
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/hub/search#get-v1-search"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/mail/verify",
   "url": "https://<your-org>.brambleit.cloud/auth/mail/verify",
   "summary": "Check a mail sign-in (mail server only)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user",
     "type": "any",
     "required": false
    },
    {
     "name": "password",
     "type": "any",
     "required": false
    },
    {
     "name": "service",
     "type": "any",
     "required": false
    },
    {
     "name": "rip",
     "type": "any",
     "required": false
    },
    {
     "name": "target",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-mail-verify"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/mail/token",
   "url": "https://<your-org>.brambleit.cloud/auth/mail/token",
   "summary": "Mail app sign-in (Bramble Mail only)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sign-in#post-auth-mail-token"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/login",
   "url": "https://<your-org>.brambleit.cloud/auth/login",
   "summary": "Sign in",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "email",
     "type": "string",
     "required": true
    },
    {
     "name": "shaPassword",
     "type": "any",
     "required": true
    },
    {
     "name": "totp",
     "type": "any",
     "required": true
    },
    {
     "name": "redirect",
     "type": "any",
     "required": false
    },
    {
     "name": "ip",
     "type": "any",
     "required": false
    },
    {
     "name": "browser",
     "type": "any",
     "required": false
    },
    {
     "name": "platform",
     "type": "any",
     "required": false
    },
    {
     "name": "userAgent",
     "type": "any",
     "required": false
    },
    {
     "name": "login_country",
     "type": "any",
     "required": false
    },
    {
     "name": "login_region",
     "type": "any",
     "required": false
    },
    {
     "name": "login_city",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-login"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/mfa/setup-generate",
   "url": "https://<your-org>.brambleit.cloud/auth/mfa/setup-generate",
   "summary": "Start required two-step setup during sign-in",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "setupToken",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-mfa-setup-generate"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/mfa/setup-verify",
   "url": "https://<your-org>.brambleit.cloud/auth/mfa/setup-verify",
   "summary": "Finish required two-step setup and sign in",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "setupToken",
     "type": "string",
     "required": false
    },
    {
     "name": "code",
     "type": "any",
     "required": true
    },
    {
     "name": "ip",
     "type": "any",
     "required": false
    },
    {
     "name": "browser",
     "type": "any",
     "required": false
    },
    {
     "name": "platform",
     "type": "any",
     "required": false
    },
    {
     "name": "userAgent",
     "type": "any",
     "required": false
    },
    {
     "name": "login_country",
     "type": "any",
     "required": false
    },
    {
     "name": "login_region",
     "type": "any",
     "required": false
    },
    {
     "name": "login_city",
     "type": "any",
     "required": false
    },
    {
     "name": "redirect",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-mfa-setup-verify"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/forgot-password",
   "url": "https://<your-org>.brambleit.cloud/auth/forgot-password",
   "summary": "Send a password reset email",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "email",
     "type": "string",
     "required": true
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-forgot-password"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/reset-password",
   "url": "https://<your-org>.brambleit.cloud/auth/reset-password",
   "summary": "Set a new password from a reset link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "token",
     "type": "string",
     "required": true
    },
    {
     "name": "shaPassword",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-reset-password"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/register/check-slug",
   "url": "https://<your-org>.brambleit.cloud/auth/register/check-slug",
   "summary": "Preview an organisation's address",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "company_name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-register-check-slug"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/find-workspace",
   "url": "https://<your-org>.brambleit.cloud/auth/find-workspace",
   "summary": "Find your organisation's address",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "email",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-find-workspace"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/register",
   "url": "https://<your-org>.brambleit.cloud/auth/register",
   "summary": "Sign up a new organisation",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "company_name",
     "type": "string",
     "required": true
    },
    {
     "name": "org_type",
     "type": "string",
     "required": false
    },
    {
     "name": "first_name",
     "type": "string",
     "required": true
    },
    {
     "name": "last_name",
     "type": "string",
     "required": true
    },
    {
     "name": "recovery_email",
     "type": "string",
     "required": true
    },
    {
     "name": "shaPassword",
     "type": "any",
     "required": true
    },
    {
     "name": "terms_accepted",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/hub/sign-in#post-auth-register"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "GET",
   "path": "/auth/verify-email",
   "url": "https://<your-org>.brambleit.cloud/auth/verify-email",
   "summary": "Confirm an email address from a sign-up link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [
    "token"
   ],
   "body": [],
   "docs": "/developers/reference/hub/sign-in#get-auth-verify-email"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/refresh",
   "url": "https://<your-org>.brambleit.cloud/auth/refresh",
   "summary": "Renew the short-lived session token",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sign-in#post-auth-refresh"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "GET",
   "path": "/auth/validate",
   "url": "https://<your-org>.brambleit.cloud/auth/validate",
   "summary": "Is this session still valid?",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sign-in#get-auth-validate"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "GET",
   "path": "/auth/bridge",
   "url": "https://<your-org>.brambleit.cloud/auth/bridge",
   "summary": "Carry a sign-in over to the organisation's address",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [
    "ott",
    "next"
   ],
   "body": [],
   "docs": "/developers/reference/hub/sign-in#get-auth-bridge"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/logout",
   "url": "https://<your-org>.brambleit.cloud/auth/logout",
   "summary": "Sign out",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sign-in#post-auth-logout"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "POST",
   "path": "/auth/logout-all",
   "url": "https://<your-org>.brambleit.cloud/auth/logout-all",
   "summary": "Sign out everywhere",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/sign-in#post-auth-logout-all"
  },
  {
   "section": "hub",
   "resource": "sign-in",
   "method": "GET",
   "path": "/auth/check",
   "url": "https://<your-org>.brambleit.cloud/auth/check",
   "summary": "Who is signed in?",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [
    "redirect"
   ],
   "body": [],
   "docs": "/developers/reference/hub/sign-in#get-auth-check"
  },
  {
   "section": "hub",
   "resource": "api-keys",
   "method": "POST",
   "path": "/auth/generate-api-key",
   "url": "https://<your-org>.brambleit.cloud/auth/generate-api-key",
   "summary": "Create an API key",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/api-keys#post-auth-generate-api-key"
  },
  {
   "section": "hub",
   "resource": "api-keys",
   "method": "GET",
   "path": "/auth/api-keys",
   "url": "https://<your-org>.brambleit.cloud/auth/api-keys",
   "summary": "List your API keys",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/api-keys#get-auth-api-keys"
  },
  {
   "section": "hub",
   "resource": "api-keys",
   "method": "POST",
   "path": "/auth/api-keys/:id/revoke",
   "url": "https://<your-org>.brambleit.cloud/auth/api-keys/:id/revoke",
   "summary": "Revoke an API key",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/api-keys#post-auth-api-keys-id-revoke"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "GET",
   "path": "/.well-known/openid-configuration",
   "url": "https://<your-org>.brambleit.cloud/.well-known/openid-configuration",
   "summary": "OpenID Connect discovery",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/openid-connect#get-well-known-openid-configuration"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "GET",
   "path": "/auth/oidc/jwks.json",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/jwks.json",
   "summary": "Signing keys (JWKS)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/openid-connect#get-auth-oidc-jwks-json"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "GET",
   "path": "/auth/oidc/authorize",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/authorize",
   "summary": "Start sign-in for an app (authorise)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [
    "client_id",
    "redirect_uri",
    "response_type",
    "scope",
    "state",
    "code_challenge",
    "code_challenge_method",
    "nonce"
   ],
   "body": [],
   "docs": "/developers/reference/hub/openid-connect#get-auth-oidc-authorize"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "GET",
   "path": "/auth/oidc/consent-info",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/consent-info",
   "summary": "What the consent screen should show",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/openid-connect#get-auth-oidc-consent-info"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "POST",
   "path": "/auth/oidc/consent",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/consent",
   "summary": "Allow or deny an app",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "decision",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/openid-connect#post-auth-oidc-consent"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "POST",
   "path": "/auth/oidc/token",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/token",
   "summary": "Get tokens",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "grant_type",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/openid-connect#post-auth-oidc-token"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "POST",
   "path": "/auth/oidc/device_authorization",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/device_authorization",
   "summary": "Start device sign-in",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "scope",
     "type": "any",
     "required": false
    },
    {
     "name": "device_name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/openid-connect#post-auth-oidc-device-authorization"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "GET",
   "path": "/auth/oidc/device",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/device",
   "summary": "Under /oidc/ because BRM-Gateway proxies /oidc/* (and /auth/oidc/* on a tenant domain) on every host; a root /device isn't routed",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/openid-connect#get-auth-oidc-device"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "GET",
   "path": "/auth/oidc/device/info",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/device/info",
   "summary": "What a device code is for",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [
    "user_code"
   ],
   "body": [],
   "docs": "/developers/reference/hub/openid-connect#get-auth-oidc-device-info"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "POST",
   "path": "/auth/oidc/device/decision",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/device/decision",
   "summary": "Approve or deny a device",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_code",
     "type": "any",
     "required": false
    },
    {
     "name": "decision",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hub/openid-connect#post-auth-oidc-device-decision"
  },
  {
   "section": "hub",
   "resource": "openid-connect",
   "method": "GET",
   "path": "/auth/oidc/userinfo",
   "url": "https://<your-org>.brambleit.cloud/auth/oidc/userinfo",
   "summary": "The signed-in person's claims",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hub/openid-connect#get-auth-oidc-userinfo"
  },
  {
   "section": "admin",
   "resource": "organisation",
   "method": "GET",
   "path": "/v1/admin/isadmin",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/isadmin",
   "summary": "Can the caller use the Admin Centre?",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/organisation#get-v1-admin-isadmin"
  },
  {
   "section": "admin",
   "resource": "organisation",
   "method": "GET",
   "path": "/v1/admin/tenant/info",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/info",
   "summary": "Get the organisation",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/organisation#get-v1-admin-tenant-info"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "PATCH",
   "path": "/v1/admin/tenant/session-policy",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/session-policy",
   "summary": "Set how long people stay signed in",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "session_ttl_days",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/security-policies#patch-v1-admin-tenant-session-policy"
  },
  {
   "section": "admin",
   "resource": "organisation",
   "method": "PATCH",
   "path": "/v1/admin/tenant/support-access",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/support-access",
   "summary": "Allow or stop Bramble support access",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/organisation#patch-v1-admin-tenant-support-access"
  },
  {
   "section": "admin",
   "resource": "organisation",
   "method": "PATCH",
   "path": "/v1/admin/tenant/name",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/name",
   "summary": "Rename the organisation",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/organisation#patch-v1-admin-tenant-name"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "GET",
   "path": "/v1/admin/tenant/security-policies",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/security-policies",
   "summary": "List the tenant's Conditional Access-style security policies",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/security-policies#get-v1-admin-tenant-security-policies"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "POST",
   "path": "/v1/admin/tenant/security-policies",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/security-policies",
   "summary": "Create a security policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "control",
     "type": "string: \"require_mfa\" \\| \"block\"",
     "required": false
    },
    {
     "name": "target_scope",
     "type": "any: \"all\" \\| \"specific\"",
     "required": false
    },
    {
     "name": "applies_to_user_types",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/security-policies#post-v1-admin-tenant-security-policies"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "PATCH",
   "path": "/v1/admin/tenant/security-policies/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/security-policies/:id",
   "summary": "Update a security policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "control",
     "type": "string: \"require_mfa\" \\| \"block\"",
     "required": false
    },
    {
     "name": "target_scope",
     "type": "string: \"all\" \\| \"specific\"",
     "required": false
    },
    {
     "name": "applies_to_user_types",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/security-policies#patch-v1-admin-tenant-security-policies-id"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "DELETE",
   "path": "/v1/admin/tenant/security-policies/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/security-policies/:id",
   "summary": "Delete a security policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/security-policies#delete-v1-admin-tenant-security-policies-id"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "POST",
   "path": "/v1/admin/tenant/security-policies/:id/subjects",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/security-policies/:id/subjects",
   "summary": "Add an include/exclude subject (user or group) to a security policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "mode",
     "type": "string: \"include\" \\| \"exclude\"",
     "required": false
    },
    {
     "name": "subject_type",
     "type": "string: \"user\" \\| \"group\"",
     "required": false
    },
    {
     "name": "subject_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/security-policies#post-v1-admin-tenant-security-policies-id-subjects"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "DELETE",
   "path": "/v1/admin/tenant/security-policies/:id/subjects/:subjectRowId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/security-policies/:id/subjects/:subjectRowId",
   "summary": "Remove a subject entry from a security policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "subjectRowId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/security-policies#delete-v1-admin-tenant-security-policies-id-subjects-subjectrowid"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "POST",
   "path": "/v1/admin/tenant/security-policies/:id/locations",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/security-policies/:id/locations",
   "summary": "Add an include/exclude named-location condition to a security policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "mode",
     "type": "string: \"include\" \\| \"exclude\"",
     "required": false
    },
    {
     "name": "named_location_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/security-policies#post-v1-admin-tenant-security-policies-id-locations"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "DELETE",
   "path": "/v1/admin/tenant/security-policies/:id/locations/:locationRowId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/security-policies/:id/locations/:locationRowId",
   "summary": "Remove a location condition from a security policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "locationRowId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/security-policies#delete-v1-admin-tenant-security-policies-id-locations-locationrowid"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "GET",
   "path": "/v1/admin/tenant/named-locations",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/named-locations",
   "summary": "List the tenant's named locations",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/security-policies#get-v1-admin-tenant-named-locations"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "POST",
   "path": "/v1/admin/tenant/named-locations",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/named-locations",
   "summary": "Create a named location",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/security-policies#post-v1-admin-tenant-named-locations"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "PATCH",
   "path": "/v1/admin/tenant/named-locations/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/named-locations/:id",
   "summary": "Rename/update a named location",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/security-policies#patch-v1-admin-tenant-named-locations-id"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "DELETE",
   "path": "/v1/admin/tenant/named-locations/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/named-locations/:id",
   "summary": "Delete a named location",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/security-policies#delete-v1-admin-tenant-named-locations-id"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "POST",
   "path": "/v1/admin/tenant/named-locations/:id/entries",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/named-locations/:id/entries",
   "summary": "Add a country or CIDR match entry to a named location",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "match_type",
     "type": "string: \"country\" \\| \"cidr\"",
     "required": false
    },
    {
     "name": "value",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/security-policies#post-v1-admin-tenant-named-locations-id-entries"
  },
  {
   "section": "admin",
   "resource": "security-policies",
   "method": "DELETE",
   "path": "/v1/admin/tenant/named-locations/:id/entries/:entryId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/named-locations/:id/entries/:entryId",
   "summary": "Remove a match entry from a named location",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "entryId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/security-policies#delete-v1-admin-tenant-named-locations-id-entries-entryid"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "GET",
   "path": "/v1/admin/tenant/users",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/users",
   "summary": "List people",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/people#get-v1-admin-tenant-users"
  },
  {
   "section": "admin",
   "resource": "domains",
   "method": "GET",
   "path": "/v1/admin/tenant/domains",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/domains",
   "summary": "List the tenant's verified/pending domains",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/domains#get-v1-admin-tenant-domains"
  },
  {
   "section": "admin",
   "resource": "groups",
   "method": "GET",
   "path": "/v1/admin/tenant/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups",
   "summary": "List the tenant's groups with member counts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/groups#get-v1-admin-tenant-groups"
  },
  {
   "section": "admin",
   "resource": "groups",
   "method": "GET",
   "path": "/v1/admin/tenant/groups/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id",
   "summary": "Get a group and its members",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/groups#get-v1-admin-tenant-groups-id"
  },
  {
   "section": "admin",
   "resource": "groups",
   "method": "POST",
   "path": "/v1/admin/tenant/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups",
   "summary": "Create a group. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "group_name",
     "type": "string",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/groups#post-v1-admin-tenant-groups"
  },
  {
   "section": "admin",
   "resource": "groups",
   "method": "PATCH",
   "path": "/v1/admin/tenant/groups/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id",
   "summary": "Rename a group. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "group_name",
     "type": "string",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/groups#patch-v1-admin-tenant-groups-id"
  },
  {
   "section": "admin",
   "resource": "groups",
   "method": "DELETE",
   "path": "/v1/admin/tenant/groups/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id",
   "summary": "Delete a group. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/groups#delete-v1-admin-tenant-groups-id"
  },
  {
   "section": "admin",
   "resource": "groups",
   "method": "POST",
   "path": "/v1/admin/tenant/groups/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id/members",
   "summary": "Add a user to a group",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/groups#post-v1-admin-tenant-groups-id-members"
  },
  {
   "section": "admin",
   "resource": "groups",
   "method": "DELETE",
   "path": "/v1/admin/tenant/groups/:id/members/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id/members/:userId",
   "summary": "Remove a user from a group",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "userId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/groups#delete-v1-admin-tenant-groups-id-members-userid"
  },
  {
   "section": "admin",
   "resource": "licences",
   "method": "GET",
   "path": "/v1/admin/tenant/licenses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/licenses",
   "summary": "List licence packages and seats",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/licences#get-v1-admin-tenant-licenses"
  },
  {
   "section": "admin",
   "resource": "audit",
   "method": "GET",
   "path": "/v1/admin/tenant/audit-log",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/audit-log",
   "summary": "Search/list the tenant's audit log",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [
    "limit",
    "page",
    "q",
    "method",
    "status_class",
    "from",
    "to"
   ],
   "body": [],
   "docs": "/developers/reference/admin/audit#get-v1-admin-tenant-audit-log"
  },
  {
   "section": "admin",
   "resource": "audit",
   "method": "GET",
   "path": "/v1/admin/tenant/audit-log/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/audit-log/:id",
   "summary": "Get a single audit log entry",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/audit#get-v1-admin-tenant-audit-log-id"
  },
  {
   "section": "admin",
   "resource": "audit",
   "method": "GET",
   "path": "/v1/admin/tenant/audit-events",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/audit-events",
   "summary": "Search the tenant's activity audit trail",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [
    "limit",
    "page"
   ],
   "body": [],
   "docs": "/developers/reference/admin/audit#get-v1-admin-tenant-audit-events"
  },
  {
   "section": "admin",
   "resource": "audit",
   "method": "GET",
   "path": "/v1/admin/tenant/audit-events/facets",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/audit-events/facets",
   "summary": "Filter options for the audit trail report",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/audit#get-v1-admin-tenant-audit-events-facets"
  },
  {
   "section": "admin",
   "resource": "audit",
   "method": "GET",
   "path": "/v1/admin/tenant/audit-events/export",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/audit-events/export",
   "summary": "Export the audit trail as CSV",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/audit#get-v1-admin-tenant-audit-events-export"
  },
  {
   "section": "admin",
   "resource": "audit",
   "method": "GET",
   "path": "/v1/admin/tenant/audit-events/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/audit-events/:id",
   "summary": "Get a single audit event, with modified properties",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/audit#get-v1-admin-tenant-audit-events-id"
  },
  {
   "section": "admin",
   "resource": "sign-ins",
   "method": "GET",
   "path": "/v1/admin/tenant/sign-ins",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/sign-ins",
   "summary": "Search the tenant's sign-in logs",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [
    "limit",
    "page"
   ],
   "body": [],
   "docs": "/developers/reference/admin/sign-ins#get-v1-admin-tenant-sign-ins"
  },
  {
   "section": "admin",
   "resource": "sign-ins",
   "method": "GET",
   "path": "/v1/admin/tenant/sign-ins/facets",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/sign-ins/facets",
   "summary": "Filter options for the sign-in log report",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sign-ins#get-v1-admin-tenant-sign-ins-facets"
  },
  {
   "section": "admin",
   "resource": "sign-ins",
   "method": "GET",
   "path": "/v1/admin/tenant/sign-ins/export",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/sign-ins/export",
   "summary": "Export sign-in logs as CSV",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sign-ins#get-v1-admin-tenant-sign-ins-export"
  },
  {
   "section": "admin",
   "resource": "sign-ins",
   "method": "GET",
   "path": "/v1/admin/tenant/sign-ins/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/sign-ins/:id",
   "summary": "Get a single sign-in, with the activities done in that session",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sign-ins#get-v1-admin-tenant-sign-ins-id"
  },
  {
   "section": "admin",
   "resource": "sign-ins",
   "method": "GET",
   "path": "/v1/admin/tenant/sessions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/sessions",
   "summary": "List active Bramble Cloud sessions in this tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [
    "user_id",
    "user"
   ],
   "body": [],
   "docs": "/developers/reference/admin/sign-ins#get-v1-admin-tenant-sessions"
  },
  {
   "section": "admin",
   "resource": "sign-ins",
   "method": "DELETE",
   "path": "/v1/admin/tenant/sessions/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/sessions/:id",
   "summary": "Revoke (sign out) one session",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sign-ins#delete-v1-admin-tenant-sessions-id"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "POST",
   "path": "/v1/admin/tenant/users/:id/revoke-sessions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/users/:id/revoke-sessions",
   "summary": "Sign a person out everywhere",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/people#post-v1-admin-tenant-users-id-revoke-sessions"
  },
  {
   "section": "admin",
   "resource": "organisation",
   "method": "GET",
   "path": "/v1/admin/tenant/monitoring/summary",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/monitoring/summary",
   "summary": "Health summary for the Admin Centre home page",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `audit.view`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/organisation#get-v1-admin-tenant-monitoring-summary"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "GET",
   "path": "/v1/admin/tenant/applications",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/applications",
   "summary": "List the platform-wide application catalog",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/roles#get-v1-admin-tenant-applications"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "GET",
   "path": "/v1/admin/tenant/permissions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/permissions",
   "summary": "List the full platform permission catalog",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/roles#get-v1-admin-tenant-permissions"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "GET",
   "path": "/v1/admin/tenant/roles",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/roles",
   "summary": "List all roles with their application and assigned-user count",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/roles#get-v1-admin-tenant-roles"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "GET",
   "path": "/v1/admin/tenant/roles/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/roles/:id",
   "summary": "Get a role with its full permission checklist",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/roles#get-v1-admin-tenant-roles-id"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "GET",
   "path": "/v1/admin/tenant/roles/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/roles/:id/members",
   "summary": "List the users in this tenant who hold a role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/roles#get-v1-admin-tenant-roles-id-members"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "POST",
   "path": "/v1/admin/tenant/roles/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/roles/:id/members",
   "summary": "Give a user in this tenant a role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/roles#post-v1-admin-tenant-roles-id-members"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "DELETE",
   "path": "/v1/admin/tenant/roles/:id/members/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/roles/:id/members/:userId",
   "summary": "Take a role away from a user in this tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "userId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/roles#delete-v1-admin-tenant-roles-id-members-userid"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "POST",
   "path": "/v1/admin/tenant/roles",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/roles",
   "summary": "Create a custom role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "display_name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "application_id",
     "type": "string",
     "required": false
    },
    {
     "name": "permission_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/roles#post-v1-admin-tenant-roles"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "PATCH",
   "path": "/v1/admin/tenant/roles/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/roles/:id",
   "summary": "Update a custom role's description and permissions",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "display_name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "permission_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/roles#patch-v1-admin-tenant-roles-id"
  },
  {
   "section": "admin",
   "resource": "roles",
   "method": "DELETE",
   "path": "/v1/admin/tenant/roles/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/roles/:id",
   "summary": "Delete a custom role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [
    "force"
   ],
   "body": [],
   "docs": "/developers/reference/admin/roles#delete-v1-admin-tenant-roles-id"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "GET",
   "path": "/v1/admin/tenant/oidc",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc",
   "summary": "Get OIDC SSO status and the tenant's registered OIDC clients",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#get-v1-admin-tenant-oidc"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "POST",
   "path": "/v1/admin/tenant/oidc/enable",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/enable",
   "summary": "Enable or disable OIDC SSO for the tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/oidc#post-v1-admin-tenant-oidc-enable"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "POST",
   "path": "/v1/admin/tenant/oidc/clients",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients",
   "summary": "Register a single sign-on app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "redirect_uris",
     "type": "array of any",
     "required": true
    },
    {
     "name": "launch_url",
     "type": "string",
     "required": true
    },
    {
     "name": "icon_url",
     "type": "string",
     "required": false
    },
    {
     "name": "show_in_drawer",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/oidc#post-v1-admin-tenant-oidc-clients"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "PATCH",
   "path": "/v1/admin/tenant/oidc/clients/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id",
   "summary": "Update an OIDC client's settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "redirect_uris",
     "type": "array of any",
     "required": true
    },
    {
     "name": "launch_url",
     "type": "string",
     "required": false
    },
    {
     "name": "icon_url",
     "type": "string",
     "required": false
    },
    {
     "name": "show_in_drawer",
     "type": "any",
     "required": false
    },
    {
     "name": "groups_claim_name",
     "type": "string",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/oidc#patch-v1-admin-tenant-oidc-clients-id"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "POST",
   "path": "/v1/admin/tenant/oidc/clients/:id/rotate-secret",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id/rotate-secret",
   "summary": "Rotate an OIDC client's secret",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#post-v1-admin-tenant-oidc-clients-id-rotate-secret"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "DELETE",
   "path": "/v1/admin/tenant/oidc/clients/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id",
   "summary": "Delete an OIDC client",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#delete-v1-admin-tenant-oidc-clients-id"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "GET",
   "path": "/v1/admin/tenant/oidc/clients/:id/access",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id/access",
   "summary": "Get an OIDC client's access-restriction settings and allow-listed subjects",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#get-v1-admin-tenant-oidc-clients-id-access"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "POST",
   "path": "/v1/admin/tenant/oidc/clients/:id/access/toggle",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id/access/toggle",
   "summary": "Toggle whether an OIDC client's access is restricted to an allow-list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "restrict_access",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/oidc#post-v1-admin-tenant-oidc-clients-id-access-toggle"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "POST",
   "path": "/v1/admin/tenant/oidc/clients/:id/access",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id/access",
   "summary": "Add a user or group to an OIDC client's access allow-list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "subject_type",
     "type": "string: \"user\" \\| \"group\"",
     "required": false
    },
    {
     "name": "subject_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/oidc#post-v1-admin-tenant-oidc-clients-id-access"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "DELETE",
   "path": "/v1/admin/tenant/oidc/clients/:id/access/:accessId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id/access/:accessId",
   "summary": "Remove a subject from an OIDC client's access allow-list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "accessId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#delete-v1-admin-tenant-oidc-clients-id-access-accessid"
  },
  {
   "section": "admin",
   "resource": "forms",
   "method": "GET",
   "path": "/v1/admin/forms",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/forms",
   "summary": "List every form",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `forms.admin.manage`."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/admin/forms#get-v1-admin-forms"
  },
  {
   "section": "admin",
   "resource": "forms",
   "method": "GET",
   "path": "/v1/admin/forms/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/forms/:id",
   "summary": "Get a form with its questions",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `forms.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/forms#get-v1-admin-forms-id"
  },
  {
   "section": "admin",
   "resource": "forms",
   "method": "GET",
   "path": "/v1/admin/forms/:id/collaborators",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/forms/:id/collaborators",
   "summary": "List a form's collaborators",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `forms.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/forms#get-v1-admin-forms-id-collaborators"
  },
  {
   "section": "admin",
   "resource": "forms",
   "method": "GET",
   "path": "/v1/admin/forms/:id/collaborators/available",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/forms/:id/collaborators/available",
   "summary": "People who could be added as collaborators",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `forms.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/admin/forms#get-v1-admin-forms-id-collaborators-available"
  },
  {
   "section": "admin",
   "resource": "forms",
   "method": "POST",
   "path": "/v1/admin/forms/:id/collaborators",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/forms/:id/collaborators",
   "summary": "Add a collaborator to a form",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `forms.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/forms#post-v1-admin-forms-id-collaborators"
  },
  {
   "section": "admin",
   "resource": "forms",
   "method": "DELETE",
   "path": "/v1/admin/forms/:id/collaborators/:collabId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/forms/:id/collaborators/:collabId",
   "summary": "Remove a collaborator from a form",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `forms.admin.manage`."
   ],
   "params": [
    "id",
    "collabId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/forms#delete-v1-admin-forms-id-collaborators-collabid"
  },
  {
   "section": "admin",
   "resource": "forms",
   "method": "PATCH",
   "path": "/v1/admin/forms/:id/owner",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/forms/:id/owner",
   "summary": "Give a form a new owner",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `forms.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/forms#patch-v1-admin-forms-id-owner"
  },
  {
   "section": "admin",
   "resource": "licences",
   "method": "GET",
   "path": "/v1/admin/tenant/apps-in-use",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/apps-in-use",
   "summary": "Which licensed apps are in use",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/licences#get-v1-admin-tenant-apps-in-use"
  },
  {
   "section": "admin",
   "resource": "licences",
   "method": "PATCH",
   "path": "/v1/admin/tenant/apps-in-use/:applicationId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/apps-in-use/:applicationId",
   "summary": "Mark an app as used or not",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "applicationId"
   ],
   "query": [],
   "body": [
    {
     "name": "in_use",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/licences#patch-v1-admin-tenant-apps-in-use-applicationid"
  },
  {
   "section": "admin",
   "resource": "organisation",
   "method": "PATCH",
   "path": "/v1/admin/tenant/org-type",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/org-type",
   "summary": "Set the organisation type",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "org_type",
     "type": "string: \"msp\" \\| \"company\"",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/organisation#patch-v1-admin-tenant-org-type"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "GET",
   "path": "/v1/admin/tenant/custom-links",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/custom-links",
   "summary": "List launcher links",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/branding#get-v1-admin-tenant-custom-links"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "POST",
   "path": "/v1/admin/tenant/custom-links",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/custom-links",
   "summary": "Add a launcher link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "url",
     "type": "string",
     "required": true
    },
    {
     "name": "icon_url",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/branding#post-v1-admin-tenant-custom-links"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "PATCH",
   "path": "/v1/admin/tenant/custom-links/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/custom-links/:id",
   "summary": "Change a launcher link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "url",
     "type": "string",
     "required": false
    },
    {
     "name": "icon_url",
     "type": "string",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    },
    {
     "name": "position",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/branding#patch-v1-admin-tenant-custom-links-id"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "DELETE",
   "path": "/v1/admin/tenant/custom-links/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/custom-links/:id",
   "summary": "Remove a launcher link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/branding#delete-v1-admin-tenant-custom-links-id"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "GET",
   "path": "/v1/admin/tenant/oidc/platform-apps",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/platform-apps",
   "summary": "List Bramble's own platform apps",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#get-v1-admin-tenant-oidc-platform-apps"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "POST",
   "path": "/v1/admin/tenant/oidc/platform-apps/:clientId/enable",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/platform-apps/:clientId/enable",
   "summary": "Opt the tenant into a platform OIDC app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "clientId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#post-v1-admin-tenant-oidc-platform-apps-clientid-enable"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "POST",
   "path": "/v1/admin/tenant/oidc/platform-apps/:clientId/disable",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/platform-apps/:clientId/disable",
   "summary": "Opt the tenant out of a platform OIDC app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "clientId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#post-v1-admin-tenant-oidc-platform-apps-clientid-disable"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "POST",
   "path": "/v1/admin/tenant/oidc/clients/:id/icon",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id/icon",
   "summary": "Upload a drawer/rail icon for an OIDC client",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#post-v1-admin-tenant-oidc-clients-id-icon"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "DELETE",
   "path": "/v1/admin/tenant/oidc/clients/:id/icon",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/clients/:id/icon",
   "summary": "Remove an OIDC client's uploaded icon",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#delete-v1-admin-tenant-oidc-clients-id-icon"
  },
  {
   "section": "admin",
   "resource": "oidc",
   "method": "GET",
   "path": "/v1/admin/tenant/oidc/icons/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/oidc/icons/:id",
   "summary": "Serve an uploaded OIDC client icon",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/oidc#get-v1-admin-tenant-oidc-icons-id"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "GET",
   "path": "/v1/admin/tenant/branding",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/branding",
   "summary": "Get the tenant's branding settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/branding#get-v1-admin-tenant-branding"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "PUT",
   "path": "/v1/admin/tenant/branding",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/branding",
   "summary": "Set colours and sign-in wording",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "primary_color",
     "type": "any",
     "required": false
    },
    {
     "name": "accent_color",
     "type": "any",
     "required": false
    },
    {
     "name": "login_headline",
     "type": "string",
     "required": false
    },
    {
     "name": "login_subtext",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/branding#put-v1-admin-tenant-branding"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "POST",
   "path": "/v1/admin/tenant/branding/logo",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/branding/logo",
   "summary": "Upload the tenant's branding logo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/branding#post-v1-admin-tenant-branding-logo"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "POST",
   "path": "/v1/admin/tenant/branding/background",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/branding/background",
   "summary": "Upload the tenant's branding background image",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/branding#post-v1-admin-tenant-branding-background"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "DELETE",
   "path": "/v1/admin/tenant/branding/logo",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/branding/logo",
   "summary": "Remove the tenant's branding logo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/branding#delete-v1-admin-tenant-branding-logo"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "DELETE",
   "path": "/v1/admin/tenant/branding/background",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/branding/background",
   "summary": "Remove the tenant's branding background image",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/branding#delete-v1-admin-tenant-branding-background"
  },
  {
   "section": "admin",
   "resource": "branding",
   "method": "GET",
   "path": "/v1/admin/tenant/branding/image/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/branding/image/:id",
   "summary": "Serve a tenant branding image (logo or background)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/branding#get-v1-admin-tenant-branding-image-id"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "GET",
   "path": "/v1/admin/tenant/subjects/users",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/subjects/users",
   "summary": "Find people (for pickers)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/admin/people#get-v1-admin-tenant-subjects-users"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "GET",
   "path": "/v1/admin/tenant/subjects/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/subjects/groups",
   "summary": "Find groups (for pickers)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/admin/people#get-v1-admin-tenant-subjects-groups"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "POST",
   "path": "/v1/admin/user/check-email",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/check-email",
   "summary": "Is this address free?",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "local_part",
     "type": "string",
     "required": true
    },
    {
     "name": "domain",
     "type": "string",
     "required": true
    },
    {
     "name": "exclude_user_id",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#post-v1-admin-user-check-email"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "POST",
   "path": "/v1/admin/user",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user",
   "summary": "Create a person",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "first_name",
     "type": "string",
     "required": false
    },
    {
     "name": "last_name",
     "type": "string",
     "required": false
    },
    {
     "name": "display_name",
     "type": "string",
     "required": false
    },
    {
     "name": "email",
     "type": "string",
     "required": true
    },
    {
     "name": "recovery_email",
     "type": "string",
     "required": false
    },
    {
     "name": "department",
     "type": "any",
     "required": false
    },
    {
     "name": "job_title",
     "type": "string",
     "required": false
    },
    {
     "name": "location",
     "type": "any",
     "required": false
    },
    {
     "name": "password",
     "type": "any",
     "required": true
    },
    {
     "name": "roles",
     "type": "array of any",
     "required": false
    },
    {
     "name": "package_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "group_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#post-v1-admin-user"
  },
  {
   "section": "admin",
   "resource": "guests",
   "method": "POST",
   "path": "/v1/admin/portal/contacts/:contactId/invite",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/portal/contacts/:contactId/invite",
   "summary": "Invite a PSA contact as a client-portal user",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "contactId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/guests#post-v1-admin-portal-contacts-contactid-invite"
  },
  {
   "section": "admin",
   "resource": "guests",
   "method": "GET",
   "path": "/v1/admin/portal/contacts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/portal/contacts",
   "summary": "List every client-portal login in the tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/guests#get-v1-admin-portal-contacts"
  },
  {
   "section": "admin",
   "resource": "guests",
   "method": "POST",
   "path": "/v1/admin/portal/contacts/:userId/revoke",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/portal/contacts/:userId/revoke",
   "summary": "Revoke a client-portal user's access",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "userId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/guests#post-v1-admin-portal-contacts-userid-revoke"
  },
  {
   "section": "admin",
   "resource": "guests",
   "method": "POST",
   "path": "/v1/admin/guests/invite",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/guests/invite",
   "summary": "Invite a guest user by email",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "email",
     "type": "string",
     "required": false
    },
    {
     "name": "display_name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/guests#post-v1-admin-guests-invite"
  },
  {
   "section": "admin",
   "resource": "guests",
   "method": "GET",
   "path": "/v1/admin/guests",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/guests",
   "summary": "List the tenant's guest users",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/guests#get-v1-admin-guests"
  },
  {
   "section": "admin",
   "resource": "guests",
   "method": "POST",
   "path": "/v1/admin/guests/:guestId/resend",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/guests/:guestId/resend",
   "summary": "Resend a guest's set-password invite link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "guestId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/guests#post-v1-admin-guests-guestid-resend"
  },
  {
   "section": "admin",
   "resource": "guests",
   "method": "POST",
   "path": "/v1/admin/guests/:guestId/revoke",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/guests/:guestId/revoke",
   "summary": "Revoke a guest's access",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "guestId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/guests#post-v1-admin-guests-guestid-revoke"
  },
  {
   "section": "admin",
   "resource": "domains",
   "method": "POST",
   "path": "/v1/admin/tenant/domains/verify",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/domains/verify",
   "summary": "Check a domain's verification record",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/domains#post-v1-admin-tenant-domains-verify"
  },
  {
   "section": "admin",
   "resource": "domains",
   "method": "POST",
   "path": "/v1/admin/tenant/domains/add",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/domains/add",
   "summary": "Add a domain",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/domains#post-v1-admin-tenant-domains-add"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "POST",
   "path": "/v1/admin/tenant/user",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/user",
   "summary": "Get a person",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#post-v1-admin-tenant-user"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PUT",
   "path": "/v1/admin/tenant/users/:id/picture",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/users/:id/picture",
   "summary": "Set a person's photo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "image",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#put-v1-admin-tenant-users-id-picture"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "DELETE",
   "path": "/v1/admin/tenant/users/:id/picture",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/users/:id/picture",
   "summary": "Remove a person's photo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/people#delete-v1-admin-tenant-users-id-picture"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/tenant/user",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/user",
   "summary": "Change one field on a person",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "updatedField",
     "type": "string",
     "required": false
    },
    {
     "name": "updatedData",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-tenant-user"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/user/profile",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/profile",
   "summary": "Update a person's name details",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "display_name",
     "type": "string",
     "required": false
    },
    {
     "name": "first_name",
     "type": "string",
     "required": false
    },
    {
     "name": "last_name",
     "type": "string",
     "required": false
    },
    {
     "name": "recovery_email",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-user-profile"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/user/account",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/account",
   "summary": "Update a person's account",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "department",
     "type": "any",
     "required": false
    },
    {
     "name": "job_title",
     "type": "string",
     "required": false
    },
    {
     "name": "location",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-user-account"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "GET",
   "path": "/v1/admin/user/addresses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/addresses",
   "summary": "A person's username and aliases",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [
    "user_id"
   ],
   "body": [],
   "docs": "/developers/reference/admin/people#get-v1-admin-user-addresses"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/user/username",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/username",
   "summary": "Change a person's username",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "number",
     "required": false
    },
    {
     "name": "local_part",
     "type": "any",
     "required": false
    },
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "keep_old_as_alias",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-user-username"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "POST",
   "path": "/v1/admin/user/aliases",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/aliases",
   "summary": "Add an email alias",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "number",
     "required": false
    },
    {
     "name": "local_part",
     "type": "any",
     "required": false
    },
    {
     "name": "domain",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#post-v1-admin-user-aliases"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "DELETE",
   "path": "/v1/admin/user/aliases/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/aliases/:id",
   "summary": "Remove an email alias",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [
    "user_id"
   ],
   "body": [],
   "docs": "/developers/reference/admin/people#delete-v1-admin-user-aliases-id"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/user/mailbox",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/mailbox",
   "summary": "Change a person's mailbox",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "mailbox_enabled",
     "type": "any",
     "required": false
    },
    {
     "name": "mailbox_quota_gb",
     "type": "any",
     "required": false
    },
    {
     "name": "mailbox_plan",
     "type": "any",
     "required": false
    },
    {
     "name": "forwarding_address",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-user-mailbox"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/user/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/groups",
   "summary": "Set a person's groups",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "group_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-user-groups"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/user/roles",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/roles",
   "summary": "Set a person's roles",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "number",
     "required": true
    },
    {
     "name": "roles",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-user-roles"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/user/licenses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/licenses",
   "summary": "Set a person's licences",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "license_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-user-licenses"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "PATCH",
   "path": "/v1/admin/user/security",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/security",
   "summary": "Reset a person's password",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "new_password",
     "type": "any",
     "required": true
    },
    {
     "name": "confirm_password",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/people#patch-v1-admin-user-security"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "POST",
   "path": "/v1/admin/user/mfa/reset",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user/mfa/reset",
   "summary": "Reset a person's two-step sign-in",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/people#post-v1-admin-user-mfa-reset"
  },
  {
   "section": "admin",
   "resource": "domains",
   "method": "POST",
   "path": "/v1/admin/domains/view",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/domains/view",
   "summary": "Get a domain",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/domains#post-v1-admin-domains-view"
  },
  {
   "section": "admin",
   "resource": "people",
   "method": "DELETE",
   "path": "/v1/admin/user",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/user",
   "summary": "Delete a person",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "number",
     "required": true
    },
    {
     "name": "mailbox",
     "type": "string: \"shared\" \\| \"delete\"",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/people#delete-v1-admin-user"
  },
  {
   "section": "admin",
   "resource": "domains",
   "method": "DELETE",
   "path": "/v1/admin/tenant/domains",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/domains",
   "summary": "Remove a domain",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/domains#delete-v1-admin-tenant-domains"
  },
  {
   "section": "admin",
   "resource": "licences",
   "method": "POST",
   "path": "/v1/admin/tenant/license",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/license",
   "summary": "Get a licence package",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "tenant_package_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/licences#post-v1-admin-tenant-license"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "GET",
   "path": "/v1/admin/rmm/overview",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/overview",
   "summary": "Get device/site/group/script counts for the tenant's RMM instance",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `RMM_ANY`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-sites#get-v1-admin-rmm-overview"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "GET",
   "path": "/v1/admin/rmm/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/sites",
   "summary": "List the tenant's RMM sites with group and device counts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `RMM_ANY`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-sites#get-v1-admin-rmm-sites"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "GET",
   "path": "/v1/admin/rmm/sites/:id/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/sites/:id/groups",
   "summary": "Get an RMM site with its groups and per-group device counts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `RMM_ANY`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-sites#get-v1-admin-rmm-sites-id-groups"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "GET",
   "path": "/v1/admin/rmm/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/groups",
   "summary": "List all RMM groups across every site in the tenant, with device counts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `RMM_ANY`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-sites#get-v1-admin-rmm-groups"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "GET",
   "path": "/v1/admin/rmm/scripts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/scripts",
   "summary": "List RMM scripts available to the tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`, `rmm.scripts.run`, `rmm.checks.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-scripts#get-v1-admin-rmm-scripts"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "GET",
   "path": "/v1/admin/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/scripts/:id",
   "summary": "Get one RMM script's full record, including its body",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`, `rmm.scripts.run`, `rmm.checks.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-scripts#get-v1-admin-rmm-scripts-id"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "POST",
   "path": "/v1/admin/rmm/scripts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/scripts",
   "summary": "Create an RMM script",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "language",
     "type": "any",
     "required": true
    },
    {
     "name": "script_body",
     "type": "any",
     "required": true
    },
    {
     "name": "timeout_seconds",
     "type": "array of any",
     "required": false
    },
    {
     "name": "is_enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "category_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-scripts#post-v1-admin-rmm-scripts"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "PUT",
   "path": "/v1/admin/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/scripts/:id",
   "summary": "Update an RMM script",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "language",
     "type": "any",
     "required": false
    },
    {
     "name": "script_body",
     "type": "any",
     "required": false
    },
    {
     "name": "timeout_seconds",
     "type": "array of any",
     "required": false
    },
    {
     "name": "is_enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "category_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-scripts#put-v1-admin-rmm-scripts-id"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "DELETE",
   "path": "/v1/admin/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/scripts/:id",
   "summary": "Delete an RMM script",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-scripts#delete-v1-admin-rmm-scripts-id"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "GET",
   "path": "/v1/admin/rmm/script-categories",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/script-categories",
   "summary": "List the tenant's RMM script folders",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`, `rmm.scripts.run`, `rmm.checks.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-scripts#get-v1-admin-rmm-script-categories"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "POST",
   "path": "/v1/admin/rmm/script-categories",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/script-categories",
   "summary": "Create an RMM script folder",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-scripts#post-v1-admin-rmm-script-categories"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "PUT",
   "path": "/v1/admin/rmm/script-categories/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/script-categories/:id",
   "summary": "Rename or re-parent an RMM script folder",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-scripts#put-v1-admin-rmm-script-categories-id"
  },
  {
   "section": "admin",
   "resource": "rmm-scripts",
   "method": "DELETE",
   "path": "/v1/admin/rmm/script-categories/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/script-categories/:id",
   "summary": "Delete an RMM script folder and its subtree",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-scripts#delete-v1-admin-rmm-script-categories-id"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v1/admin/rmm/checks",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/checks",
   "summary": "List checks",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.view`, `rmm.checks.manage`, `rmm.alerts.resolve`, `rmm.integrations.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-checks#get-v1-admin-rmm-checks"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v1/admin/rmm/checks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/checks/:id",
   "summary": "Get a check with its actions and assignments",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.view`, `rmm.checks.manage`, `rmm.alerts.resolve`, `rmm.integrations.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-checks#get-v1-admin-rmm-checks-id"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v1/admin/rmm/checks",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/checks",
   "summary": "Create a check",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "check_type",
     "type": "string: \"cpu_usage\" \\| \"ram_usage\" \\| \"disk_usage\" \\| \"disk_free\" \\| \"service_stopped\" \\| \"device_offline\" \\| \"docker_container_down\" \\| \"proxmox_guest_down\" \\| \"pbs_datastore_usage\" \\| \"http_check\" \\| \"tcp_check\" \\| \"ping_check\" \\| \"proxmox_host_health\" \\| \"proxmox_backup_missing\" \\| \"network_device_down\" \\| \"network_interface_down\" \\| \"mysql_backup\" \\| \"device_backup\"",
     "required": true
    },
    {
     "name": "check_config",
     "type": "object",
     "required": true
    },
    {
     "name": "severity",
     "type": "any: \"info\" \\| \"warning\" \\| \"critical\"",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "assignments",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-checks#post-v1-admin-rmm-checks"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "PUT",
   "path": "/v1/admin/rmm/checks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/checks/:id",
   "summary": "Update a check",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "check_type",
     "type": "string",
     "required": false
    },
    {
     "name": "check_config",
     "type": "any",
     "required": false
    },
    {
     "name": "severity",
     "type": "any",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "assignments",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-checks#put-v1-admin-rmm-checks-id"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v1/admin/rmm/checks/:id/toggle",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/checks/:id/toggle",
   "summary": "Turn a check on or off",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-checks#post-v1-admin-rmm-checks-id-toggle"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "DELETE",
   "path": "/v1/admin/rmm/checks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/checks/:id",
   "summary": "Delete a check",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-checks#delete-v1-admin-rmm-checks-id"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v1/admin/rmm/alerts/stats",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/alerts/stats",
   "summary": "Alert statistics",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.view`, `rmm.checks.manage`, `rmm.alerts.resolve`, `rmm.integrations.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-checks#get-v1-admin-rmm-alerts-stats"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v1/admin/rmm/alerts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/alerts",
   "summary": "List alerts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.view`, `rmm.checks.manage`, `rmm.alerts.resolve`, `rmm.integrations.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-checks#get-v1-admin-rmm-alerts"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v1/admin/rmm/alerts/:id/resolve",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/alerts/:id/resolve",
   "summary": "Resolve an alert",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.alerts.resolve`, `rmm.checks.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-checks#post-v1-admin-rmm-alerts-id-resolve"
  },
  {
   "section": "admin",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v1/admin/rmm/alerts/active",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/alerts/active",
   "summary": "List active alerts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.checks.view`, `rmm.checks.manage`, `rmm.alerts.resolve`, `rmm.integrations.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-checks#get-v1-admin-rmm-alerts-active"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "GET",
   "path": "/v1/admin/rmm/tasks",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/tasks",
   "summary": "List scheduled tasks",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#get-v1-admin-rmm-tasks"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "GET",
   "path": "/v1/admin/rmm/tasks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/tasks/:id",
   "summary": "Get a task with its steps and assignments",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#get-v1-admin-rmm-tasks-id"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "POST",
   "path": "/v1/admin/rmm/tasks",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/tasks",
   "summary": "Create a scheduled task",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "schedule",
     "type": "object",
     "required": true
    },
    {
     "name": "on_failure_notify",
     "type": "any",
     "required": false
    },
    {
     "name": "notify_config",
     "type": "string",
     "required": false
    },
    {
     "name": "device_filters",
     "type": "array of any",
     "required": false
    },
    {
     "name": "assignments",
     "type": "array of any",
     "required": false
    },
    {
     "name": "steps",
     "type": "array of any",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/rmm-tasks#post-v1-admin-rmm-tasks"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "PUT",
   "path": "/v1/admin/rmm/tasks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/tasks/:id",
   "summary": "Update a scheduled task",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "schedule",
     "type": "any",
     "required": false
    },
    {
     "name": "on_failure_notify",
     "type": "any",
     "required": false
    },
    {
     "name": "notify_config",
     "type": "string",
     "required": false
    },
    {
     "name": "device_filters",
     "type": "string",
     "required": false
    },
    {
     "name": "assignments",
     "type": "array of any",
     "required": false
    },
    {
     "name": "steps",
     "type": "array of any",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/rmm-tasks#put-v1-admin-rmm-tasks-id"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "POST",
   "path": "/v1/admin/rmm/tasks/:id/toggle",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/tasks/:id/toggle",
   "summary": "Turn a task on or off",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#post-v1-admin-rmm-tasks-id-toggle"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "DELETE",
   "path": "/v1/admin/rmm/tasks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/tasks/:id",
   "summary": "Delete a task",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#delete-v1-admin-rmm-tasks-id"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "POST",
   "path": "/v1/admin/rmm/tasks/:id/run",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/tasks/:id/run",
   "summary": "Run a task now",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#post-v1-admin-rmm-tasks-id-run"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "GET",
   "path": "/v1/admin/rmm/tasks/:id/runs",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/tasks/:id/runs",
   "summary": "A task's past runs",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#get-v1-admin-rmm-tasks-id-runs"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "GET",
   "path": "/v1/admin/rmm/runs",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/runs",
   "summary": "Recent task runs",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#get-v1-admin-rmm-runs"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "GET",
   "path": "/v1/admin/rmm/runs/:runId/results",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/runs/:runId/results",
   "summary": "Per-device rollup plus the full per-step timeline (client groups by device_id and orders by sort_order to render a mini step-by-step timeline per device)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "runId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#get-v1-admin-rmm-runs-runid-results"
  },
  {
   "section": "admin",
   "resource": "rmm-tasks",
   "method": "POST",
   "path": "/v1/admin/rmm/runs/:runId/cancel",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/runs/:runId/cancel",
   "summary": "Cancel a running task",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "runId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-tasks#post-v1-admin-rmm-runs-runid-cancel"
  },
  {
   "section": "admin",
   "resource": "rmm-agent-updates",
   "method": "GET",
   "path": "/v1/admin/rmm/hypervisor-scope-summary",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/hypervisor-scope-summary",
   "summary": "Hypervisors in a site or group",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `RMM_ANY`."
   ],
   "params": [],
   "query": [
    "scope_type",
    "scope_id"
   ],
   "body": [],
   "docs": "/developers/reference/admin/rmm-agent-updates#get-v1-admin-rmm-hypervisor-scope-summary"
  },
  {
   "section": "admin",
   "resource": "rmm-agent-updates",
   "method": "GET",
   "path": "/v1/admin/rmm/agent-updates",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/agent-updates",
   "summary": "Agent update policy and devices behind",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `RMM_ANY`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-agent-updates#get-v1-admin-rmm-agent-updates"
  },
  {
   "section": "admin",
   "resource": "rmm-agent-updates",
   "method": "PUT",
   "path": "/v1/admin/rmm/agent-updates",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/agent-updates",
   "summary": "Turn automatic agent updates on or off",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-agent-updates#put-v1-admin-rmm-agent-updates"
  },
  {
   "section": "admin",
   "resource": "rmm-base",
   "method": "GET",
   "path": "/v1/admin/rmm/${base}/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/${base}/sites",
   "summary": "This organisation's own RMM sites and who manages each one's devices (RMM2's site picker): the linked customer while its partnership lets us manage its devic…",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-base#get-v1-admin-rmm-base-sites"
  },
  {
   "section": "admin",
   "resource": "rmm-base",
   "method": "GET",
   "path": "/v1/admin/rmm/${base}/baselines",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/${base}/baselines",
   "summary": "List baselines",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-base#get-v1-admin-rmm-base-baselines"
  },
  {
   "section": "admin",
   "resource": "rmm-base",
   "method": "POST",
   "path": "/v1/admin/rmm/${base}/baselines",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/${base}/baselines",
   "summary": "Create a baseline",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-base#post-v1-admin-rmm-base-baselines"
  },
  {
   "section": "admin",
   "resource": "rmm-base",
   "method": "PUT",
   "path": "/v1/admin/rmm/${base}/baselines/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/${base}/baselines/:id",
   "summary": "Update a baseline",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-base#put-v1-admin-rmm-base-baselines-id"
  },
  {
   "section": "admin",
   "resource": "rmm-base",
   "method": "DELETE",
   "path": "/v1/admin/rmm/${base}/baselines/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/${base}/baselines/:id",
   "summary": "Delete a baseline",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-base#delete-v1-admin-rmm-base-baselines-id"
  },
  {
   "section": "admin",
   "resource": "rmm-base",
   "method": "PUT",
   "path": "/v1/admin/rmm/${base}/baselines/:id/targets",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/${base}/baselines/:id/targets",
   "summary": "Which organisations the baseline is deployed to (replaces the list)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "tenant_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-base#put-v1-admin-rmm-base-baselines-id-targets"
  },
  {
   "section": "admin",
   "resource": "rmm-agent-updates",
   "method": "GET",
   "path": "/v1/admin/rmm/history",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/history",
   "summary": "History retention and usage",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.logs.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-agent-updates#get-v1-admin-rmm-history"
  },
  {
   "section": "admin",
   "resource": "rmm-agent-updates",
   "method": "PUT",
   "path": "/v1/admin/rmm/history",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/history",
   "summary": "Set how long RMM history is kept",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.logs.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "utilization_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "command_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "logs_days",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-agent-updates#put-v1-admin-rmm-history"
  },
  {
   "section": "admin",
   "resource": "partners",
   "method": "GET",
   "path": "/v1/admin/partners",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/partners",
   "summary": "List partnerships",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/partners#get-v1-admin-partners"
  },
  {
   "section": "admin",
   "resource": "partners",
   "method": "POST",
   "path": "/v1/admin/partners/requests",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/partners/requests",
   "summary": "Ask to manage a customer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "permissions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/partners#post-v1-admin-partners-requests"
  },
  {
   "section": "admin",
   "resource": "partners",
   "method": "POST",
   "path": "/v1/admin/partners/:id/approve",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/partners/:id/approve",
   "summary": "Approve a partner",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "permissions",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/partners#post-v1-admin-partners-id-approve"
  },
  {
   "section": "admin",
   "resource": "partners",
   "method": "POST",
   "path": "/v1/admin/partners/:id/decline",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/partners/:id/decline",
   "summary": "Decline a partner's request",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/partners#post-v1-admin-partners-id-decline"
  },
  {
   "section": "admin",
   "resource": "partners",
   "method": "PUT",
   "path": "/v1/admin/partners/:id/permissions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/partners/:id/permissions",
   "summary": "Change what a partner may do",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "permissions",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/partners#put-v1-admin-partners-id-permissions"
  },
  {
   "section": "admin",
   "resource": "partners",
   "method": "POST",
   "path": "/v1/admin/partners/:id/end",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/partners/:id/end",
   "summary": "End a partnership",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/partners#post-v1-admin-partners-id-end"
  },
  {
   "section": "admin",
   "resource": "partners",
   "method": "GET",
   "path": "/v1/admin/partners/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/partners/sites",
   "summary": "Your RMM sites and the customers they're linked to",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/partners#get-v1-admin-partners-sites"
  },
  {
   "section": "admin",
   "resource": "partners",
   "method": "PUT",
   "path": "/v1/admin/partners/sites/:siteId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/partners/sites/:siteId",
   "summary": "Link an RMM site to a customer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "siteId"
   ],
   "query": [],
   "body": [
    {
     "name": "customer_tenant_id",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/partners#put-v1-admin-partners-sites-siteid"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "GET",
   "path": "/v1/admin/mail/mailboxes",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/mailboxes",
   "summary": "List every mailbox",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#get-v1-admin-mail-mailboxes"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "GET",
   "path": "/v1/admin/mail/domains",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/domains",
   "summary": "List mail domains and their DNS",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#get-v1-admin-mail-domains"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "POST",
   "path": "/v1/admin/mail/domains/:domain/setup",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/domains/:domain/setup",
   "summary": "Set up mail for a domain",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "domain"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#post-v1-admin-mail-domains-domain-setup"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "POST",
   "path": "/v1/admin/mail/domains/:domain/check",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/domains/:domain/check",
   "summary": "Check a mail domain's DNS now",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "domain"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#post-v1-admin-mail-domains-domain-check"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "GET",
   "path": "/v1/admin/mail/shared",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/shared",
   "summary": "List shared mailboxes",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#get-v1-admin-mail-shared"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "POST",
   "path": "/v1/admin/mail/shared",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/shared",
   "summary": "Create a shared mailbox",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "local_part",
     "type": "any",
     "required": false
    },
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "display_name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/mail#post-v1-admin-mail-shared"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "POST",
   "path": "/v1/admin/mail/shared/existing",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/shared/existing",
   "summary": "Turn an existing mailbox into a shared one",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "email",
     "type": "string",
     "required": false
    },
    {
     "name": "display_name",
     "type": "string",
     "required": false
    },
    {
     "name": "keep_sign_in",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/mail#post-v1-admin-mail-shared-existing"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "PATCH",
   "path": "/v1/admin/mail/shared/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/shared/:id",
   "summary": "Change a shared mailbox",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "display_name",
     "type": "string",
     "required": false
    },
    {
     "name": "keep_sign_in",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/mail#patch-v1-admin-mail-shared-id"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "DELETE",
   "path": "/v1/admin/mail/shared/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/shared/:id",
   "summary": "Stop sharing a mailbox",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#delete-v1-admin-mail-shared-id"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "DELETE",
   "path": "/v1/admin/mail/mailboxes/:domain/:boxId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/mailboxes/:domain/:boxId",
   "summary": "Deletes a shared or unassigned mailbox and all its mail from the server",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "domain",
    "boxId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#delete-v1-admin-mail-mailboxes-domain-boxid"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "GET",
   "path": "/v1/admin/mail/users/:userId/mailbox",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/users/:userId/mailbox",
   "summary": "A person's mailbox, so \"Remove user\" can ask what happens to it",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "userId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#get-v1-admin-mail-users-userid-mailbox"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "GET",
   "path": "/v1/admin/mail/users/:userId/app-passwords",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/users/:userId/app-passwords",
   "summary": "List a person's admin-made app passwords",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "userId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#get-v1-admin-mail-users-userid-app-passwords"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "POST",
   "path": "/v1/admin/mail/users/:userId/app-passwords",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/users/:userId/app-passwords",
   "summary": "Make an app password for a person",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "userId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/mail#post-v1-admin-mail-users-userid-app-passwords"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "DELETE",
   "path": "/v1/admin/mail/users/:userId/app-passwords/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/users/:userId/app-passwords/:id",
   "summary": "Revoke an app password",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "userId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/mail#delete-v1-admin-mail-users-userid-app-passwords-id"
  },
  {
   "section": "admin",
   "resource": "mail",
   "method": "PUT",
   "path": "/v1/admin/mail/shared/:id/members/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/mail/shared/:id/members/:userId",
   "summary": "Set a person's access to a shared mailbox",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "userId"
   ],
   "query": [],
   "body": [
    {
     "name": "full_access",
     "type": "any",
     "required": false
    },
    {
     "name": "send_as",
     "type": "array of any",
     "required": false
    },
    {
     "name": "send_on_behalf",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/mail#put-v1-admin-mail-shared-id-members-userid"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/overview",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/overview",
   "summary": "Warden configuration status + headline numbers for the admin overview",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-overview"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/network",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/network",
   "summary": "Detection + PSA integration settings, and the site -> PSA customer map",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-network"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "PUT",
   "path": "/v1/admin/warden/network",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/network",
   "summary": "Update the network",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "hour",
     "type": "integer",
     "required": false
    },
    {
     "name": "extra_targets",
     "type": "array of any",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#put-v1-admin-warden-network"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/siem",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/siem",
   "summary": "Get the SIEM",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-siem"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "PUT",
   "path": "/v1/admin/warden/siem",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/siem",
   "summary": "Update the SIEM",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "retention_days",
     "type": "number",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "process_creation",
     "type": "boolean",
     "required": false
    },
    {
     "name": "powershell",
     "type": "boolean",
     "required": false
    },
    {
     "name": "bramble_audit",
     "type": "boolean",
     "required": false
    },
    {
     "name": "audit_policy",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#put-v1-admin-warden-siem"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/settings",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/settings",
   "summary": "Get the settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-settings"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "PUT",
   "path": "/v1/admin/warden/settings",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/settings",
   "summary": "Update the settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "hide_low_priority",
     "type": "any",
     "required": false
    },
    {
     "name": "include_unfixed",
     "type": "any",
     "required": false
    },
    {
     "name": "psa_enabled",
     "type": "any",
     "required": false
    },
    {
     "name": "psa_queue_id",
     "type": "number",
     "required": false
    },
    {
     "name": "psa_default_customer_id",
     "type": "number",
     "required": false
    },
    {
     "name": "psa_auto_close",
     "type": "boolean",
     "required": false
    },
    {
     "name": "site_customers",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#put-v1-admin-warden-settings"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/lookups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/lookups",
   "summary": "RMM sites and PSA queues/customers for the settings dropdowns",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-lookups"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/ticket-rules",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/ticket-rules",
   "summary": "List ticket rules",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-ticket-rules"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "POST",
   "path": "/v1/admin/warden/ticket-rules",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/ticket-rules",
   "summary": "Create a ticket rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "min_severity",
     "type": "string: \"critical\" \\| \"high\" \\| \"medium\" \\| \"low\"",
     "required": false
    },
    {
     "name": "kev_only",
     "type": "any",
     "required": false
    },
    {
     "name": "fixable_only",
     "type": "boolean",
     "required": false
    },
    {
     "name": "site_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "priority",
     "type": "string: \"low\" \\| \"medium\" \\| \"high\" \\| \"critical\"",
     "required": false
    },
    {
     "name": "queue_id",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#post-v1-admin-warden-ticket-rules"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "PUT",
   "path": "/v1/admin/warden/ticket-rules/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/ticket-rules/:id",
   "summary": "Update a ticket rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "min_severity",
     "type": "string: \"critical\" \\| \"high\" \\| \"medium\" \\| \"low\"",
     "required": false
    },
    {
     "name": "kev_only",
     "type": "any",
     "required": false
    },
    {
     "name": "fixable_only",
     "type": "boolean",
     "required": false
    },
    {
     "name": "site_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "priority",
     "type": "string: \"low\" \\| \"medium\" \\| \"high\" \\| \"critical\"",
     "required": false
    },
    {
     "name": "queue_id",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#put-v1-admin-warden-ticket-rules-id"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "DELETE",
   "path": "/v1/admin/warden/ticket-rules/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/ticket-rules/:id",
   "summary": "Delete a ticket rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#delete-v1-admin-warden-ticket-rules-id"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/notify-channels",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/notify-channels",
   "summary": "The tenant's named notification channels Warden can deliver through (set up in Admin → RMM → Notification channels)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-notify-channels"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/notify-rules",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/notify-rules",
   "summary": "Warden notification rules, with each rule's last delivery",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-notify-rules"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "POST",
   "path": "/v1/admin/warden/notify-rules",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/notify-rules",
   "summary": "Create a notify rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "events",
     "type": "array of any",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "min_severity",
     "type": "string: \"critical\" \\| \"high\" \\| \"medium\" \\| \"low\"",
     "required": false
    },
    {
     "name": "kev_only",
     "type": "any",
     "required": false
    },
    {
     "name": "site_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#post-v1-admin-warden-notify-rules"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "PUT",
   "path": "/v1/admin/warden/notify-rules/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/notify-rules/:id",
   "summary": "Update a notification rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "events",
     "type": "array of any",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "min_severity",
     "type": "string: \"critical\" \\| \"high\" \\| \"medium\" \\| \"low\"",
     "required": false
    },
    {
     "name": "kev_only",
     "type": "any",
     "required": false
    },
    {
     "name": "site_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#put-v1-admin-warden-notify-rules-id"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "DELETE",
   "path": "/v1/admin/warden/notify-rules/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/notify-rules/:id",
   "summary": "Delete a notify rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#delete-v1-admin-warden-notify-rules-id"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "POST",
   "path": "/v1/admin/warden/notify-rules/:id/test",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/notify-rules/:id/test",
   "summary": "Queue a test message for a rule (Warden sends it within ~15s; poll notify-rules for the result)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#post-v1-admin-warden-notify-rules-id-test"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "GET",
   "path": "/v1/admin/warden/connectors",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/connectors",
   "summary": "List connectors",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#get-v1-admin-warden-connectors"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "POST",
   "path": "/v1/admin/warden/connectors",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/connectors",
   "summary": "Create a connector",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "url",
     "type": "string",
     "required": false
    },
    {
     "name": "api_key",
     "type": "string",
     "required": false
    },
    {
     "name": "poll_minutes",
     "type": "integer",
     "required": false
    },
    {
     "name": "probe_device_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#post-v1-admin-warden-connectors"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "PUT",
   "path": "/v1/admin/warden/connectors/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/connectors/:id",
   "summary": "Update a connector",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "url",
     "type": "string",
     "required": false
    },
    {
     "name": "api_key",
     "type": "string",
     "required": false
    },
    {
     "name": "poll_minutes",
     "type": "integer",
     "required": false
    },
    {
     "name": "probe_device_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/warden#put-v1-admin-warden-connectors-id"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "POST",
   "path": "/v1/admin/warden/connectors/:id/reset-pin",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/connectors/:id/reset-pin",
   "summary": "After a controller is replaced or gets a new certificate",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#post-v1-admin-warden-connectors-id-reset-pin"
  },
  {
   "section": "admin",
   "resource": "warden",
   "method": "DELETE",
   "path": "/v1/admin/warden/connectors/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/warden/connectors/:id",
   "summary": "Delete a connector",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Warden.",
    "Permission (any of): `secure.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/warden#delete-v1-admin-warden-connectors-id"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "GET",
   "path": "/v1/admin/simplebooks/companies",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/companies",
   "summary": "Every SimpleBooks company in the tenant, with modules, access and receipt counts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/simplebooks#get-v1-admin-simplebooks-companies"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "POST",
   "path": "/v1/admin/simplebooks/companies",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/companies",
   "summary": "Create a company",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "business_type",
     "type": "string: \"sole_trader\" \\| \"partnership\" \\| \"limited\"",
     "required": false
    },
    {
     "name": "trading_name",
     "type": "string",
     "required": false
    },
    {
     "name": "owner_name",
     "type": "string",
     "required": false
    },
    {
     "name": "modules",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/simplebooks#post-v1-admin-simplebooks-companies"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "PUT",
   "path": "/v1/admin/simplebooks/companies/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/companies/:id",
   "summary": "Rename, change business type, archive/unarchive, or switch modules on/off",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "trading_name",
     "type": "string",
     "required": false
    },
    {
     "name": "business_type",
     "type": "string: \"sole_trader\" \\| \"partnership\" \\| \"limited\"",
     "required": false
    },
    {
     "name": "archived",
     "type": "any",
     "required": false
    },
    {
     "name": "modules",
     "type": "object",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/simplebooks#put-v1-admin-simplebooks-companies-id"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "GET",
   "path": "/v1/admin/simplebooks/principals",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/principals",
   "summary": "Tenant users (with whether each has a SimpleBooks licence) and groups, for the access picker",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/simplebooks#get-v1-admin-simplebooks-principals"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "GET",
   "path": "/v1/admin/simplebooks/companies/:id/access",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/companies/:id/access",
   "summary": "Who can open this company, and with which role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/simplebooks#get-v1-admin-simplebooks-companies-id-access"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "POST",
   "path": "/v1/admin/simplebooks/companies/:id/access",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/companies/:id/access",
   "summary": "Access a company",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "principal_type",
     "type": "string",
     "required": false
    },
    {
     "name": "principal_id",
     "type": "number",
     "required": false
    },
    {
     "name": "role",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/simplebooks#post-v1-admin-simplebooks-companies-id-access"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "PUT",
   "path": "/v1/admin/simplebooks/companies/:id/access/:accessId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/companies/:id/access/:accessId",
   "summary": "Update an access",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "accessId"
   ],
   "query": [],
   "body": [
    {
     "name": "role",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/simplebooks#put-v1-admin-simplebooks-companies-id-access-accessid"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "DELETE",
   "path": "/v1/admin/simplebooks/companies/:id/access/:accessId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/companies/:id/access/:accessId",
   "summary": "Delete an access",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id",
    "accessId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/simplebooks#delete-v1-admin-simplebooks-companies-id-access-accessid"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "GET",
   "path": "/v1/admin/simplebooks/email",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/email",
   "summary": "The SMTP account SimpleBooks emails invoices through (password never returned)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/simplebooks#get-v1-admin-simplebooks-email"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "PUT",
   "path": "/v1/admin/simplebooks/email",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/email",
   "summary": "Update the email",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "smtp_host",
     "type": "string",
     "required": false
    },
    {
     "name": "smtp_port",
     "type": "number",
     "required": false
    },
    {
     "name": "smtp_secure",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_user",
     "type": "string",
     "required": false
    },
    {
     "name": "from_email",
     "type": "string",
     "required": false
    },
    {
     "name": "from_name",
     "type": "string",
     "required": false
    },
    {
     "name": "smtp_pass",
     "type": "string",
     "required": false
    },
    {
     "name": "clear_password",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/simplebooks#put-v1-admin-simplebooks-email"
  },
  {
   "section": "admin",
   "resource": "simplebooks",
   "method": "POST",
   "path": "/v1/admin/simplebooks/email/test",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/simplebooks/email/test",
   "summary": "Send a test email to the signed-in admin through the saved SMTP account",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/simplebooks#post-v1-admin-simplebooks-email-test"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "GET",
   "path": "/v1/admin/hr/overview",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/overview",
   "summary": "HR policy, leave types, closures, templates and licence counts in one call",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/hr#get-v1-admin-hr-overview"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "PUT",
   "path": "/v1/admin/hr/settings",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/settings",
   "summary": "Update the leave policy (leave year start, allowance, bank holidays, carry-over, half days, privacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "year_start_month",
     "type": "number",
     "required": false
    },
    {
     "name": "default_allowance",
     "type": "number",
     "required": false
    },
    {
     "name": "carry_over_max",
     "type": "number",
     "required": false
    },
    {
     "name": "bank_holidays",
     "type": "string",
     "required": false
    },
    {
     "name": "region",
     "type": "any",
     "required": false
    },
    {
     "name": "half_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "show_leave_types",
     "type": "array of any",
     "required": false
    },
    {
     "name": "overlap_mode",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#put-v1-admin-hr-settings"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "PUT",
   "path": "/v1/admin/hr/people-scope",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/people-scope",
   "summary": "Who gets an HR record automatically — every staff account (scope all) or members of chosen groups (scope groups, groups = ids)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "scope",
     "type": "string",
     "required": false
    },
    {
     "name": "groups",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#put-v1-admin-hr-people-scope"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "POST",
   "path": "/v1/admin/hr/removed/:employeeId/restore",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/removed/:employeeId/restore",
   "summary": "Restore a removed",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "employeeId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/hr#post-v1-admin-hr-removed-employeeid-restore"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "POST",
   "path": "/v1/admin/hr/types",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/types",
   "summary": "Add a leave type",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "kind",
     "type": "string",
     "required": false
    },
    {
     "name": "deducts",
     "type": "array of any",
     "required": false
    },
    {
     "name": "needs_approval",
     "type": "any",
     "required": false
    },
    {
     "name": "colour",
     "type": "any",
     "required": false
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    },
    {
     "name": "priority",
     "type": "number",
     "required": false
    },
    {
     "name": "is_absence",
     "type": "boolean",
     "required": false
    },
    {
     "name": "annual_limit",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#post-v1-admin-hr-types"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "PUT",
   "path": "/v1/admin/hr/types/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/types/:id",
   "summary": "Change a leave type, or archive / restore it ({ archived })",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "archived",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#put-v1-admin-hr-types-id"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "POST",
   "path": "/v1/admin/hr/closures",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/closures",
   "summary": "Add company closure days (a date range)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "from",
     "type": "any",
     "required": false
    },
    {
     "name": "to",
     "type": "any",
     "required": false
    },
    {
     "name": "deducts",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#post-v1-admin-hr-closures"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "PUT",
   "path": "/v1/admin/hr/closures/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/closures/:id",
   "summary": "Switch one closure day between \"extra day off\" and \"comes out of the allowance\"",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/hr#put-v1-admin-hr-closures-id"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "DELETE",
   "path": "/v1/admin/hr/closures/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/closures/:id",
   "summary": "Delete a closure",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/hr#delete-v1-admin-hr-closures-id"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "POST",
   "path": "/v1/admin/hr/templates",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/templates",
   "summary": "Add an onboarding or offboarding checklist template with its tasks",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "kind",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "tasks",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#post-v1-admin-hr-templates"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "PUT",
   "path": "/v1/admin/hr/templates/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/templates/:id",
   "summary": "Replace a template's name, description and tasks (checklists already started keep their own copy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "tasks",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#put-v1-admin-hr-templates-id"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "DELETE",
   "path": "/v1/admin/hr/templates/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/templates/:id",
   "summary": "Delete a template",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/hr#delete-v1-admin-hr-templates-id"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "GET",
   "path": "/v1/admin/hr/people/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/people/:userId",
   "summary": "Get a people",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "userId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/hr#get-v1-admin-hr-people-userid"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "PUT",
   "path": "/v1/admin/hr/people/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/people/:userId",
   "summary": "Update a people",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "userId"
   ],
   "query": [],
   "body": [
    {
     "name": "manager_id",
     "type": "string",
     "required": false
    },
    {
     "name": "work_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "hours_per_week",
     "type": "any",
     "required": false
    },
    {
     "name": "start_date",
     "type": "string (date)",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#put-v1-admin-hr-people-userid"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "POST",
   "path": "/v1/admin/hr/people/:userId/allowance-changes",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/people/:userId/allowance-changes",
   "summary": "Change a user's holiday allowance from a leave year on (kind set = days a year, extra = days on top of the policy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "userId"
   ],
   "query": [],
   "body": [
    {
     "name": "kind",
     "type": "string",
     "required": false
    },
    {
     "name": "days",
     "type": "number",
     "required": true
    },
    {
     "name": "from",
     "type": "string (date)",
     "required": true
    },
    {
     "name": "reason",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/hr#post-v1-admin-hr-people-userid-allowance-changes"
  },
  {
   "section": "admin",
   "resource": "hr",
   "method": "DELETE",
   "path": "/v1/admin/hr/people/:userId/allowance-changes/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/hr/people/:userId/allowance-changes/:id",
   "summary": "Delete an allowance change",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `hr.admin.manage`."
   ],
   "params": [
    "userId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/hr#delete-v1-admin-hr-people-userid-allowance-changes-id"
  },
  {
   "section": "admin",
   "resource": "storage",
   "method": "GET",
   "path": "/v1/admin/storage/overview",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/storage/overview",
   "summary": "The tenant's storage pool, where it comes from, and what each app uses",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `drive.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/storage#get-v1-admin-storage-overview"
  },
  {
   "section": "admin",
   "resource": "storage",
   "method": "PUT",
   "path": "/v1/admin/storage/apps/:app/quota",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/storage/apps/:app/quota",
   "summary": "Cap how much of the pool one app may use (quota_bytes null removes the cap)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `drive.admin.manage`."
   ],
   "params": [
    "app"
   ],
   "query": [],
   "body": [
    {
     "name": "quota_bytes",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/storage#put-v1-admin-storage-apps-app-quota"
  },
  {
   "section": "admin",
   "resource": "storage",
   "method": "GET",
   "path": "/v1/admin/storage/users",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/storage/users",
   "summary": "Staff users with their storage use across apps and their Drive personal quota",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `drive.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/storage#get-v1-admin-storage-users"
  },
  {
   "section": "admin",
   "resource": "storage",
   "method": "PUT",
   "path": "/v1/admin/storage/users/:userId/quota",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/storage/users/:userId/quota",
   "summary": "Set one user's Drive personal quota (quota_bytes null = unlimited; use_default true = follow the tenant default)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `drive.admin.manage`."
   ],
   "params": [
    "userId"
   ],
   "query": [],
   "body": [
    {
     "name": "use_default",
     "type": "any",
     "required": false
    },
    {
     "name": "quota_bytes",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/storage#put-v1-admin-storage-users-userid-quota"
  },
  {
   "section": "admin",
   "resource": "storage",
   "method": "GET",
   "path": "/v1/admin/storage/largest",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/storage/largest",
   "summary": "The biggest stored files across all apps (or one, with ?app=)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `drive.admin.manage`."
   ],
   "params": [],
   "query": [
    "app"
   ],
   "body": [],
   "docs": "/developers/reference/admin/storage#get-v1-admin-storage-largest"
  },
  {
   "section": "admin",
   "resource": "storage",
   "method": "GET",
   "path": "/v1/admin/storage/history",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/storage/history",
   "summary": "Daily storage use per app (?days=, default 90)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `drive.admin.manage`."
   ],
   "params": [],
   "query": [
    "days"
   ],
   "body": [],
   "docs": "/developers/reference/admin/storage#get-v1-admin-storage-history"
  },
  {
   "section": "admin",
   "resource": "storage",
   "method": "GET",
   "path": "/v1/admin/storage/drive-settings",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/storage/drive-settings",
   "summary": "Drive rules for this tenant (personal quota, versions kept, bin retention, link sharing, quick shares)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `drive.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/storage#get-v1-admin-storage-drive-settings"
  },
  {
   "section": "admin",
   "resource": "storage",
   "method": "PUT",
   "path": "/v1/admin/storage/drive-settings",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/storage/drive-settings",
   "summary": "Update the drive settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `drive.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "personal_quota_bytes",
     "type": "integer",
     "required": false
    },
    {
     "name": "version_limit",
     "type": "number",
     "required": false
    },
    {
     "name": "trash_days",
     "type": "number",
     "required": false
    },
    {
     "name": "link_max_days",
     "type": "string",
     "required": false
    },
    {
     "name": "temp_enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "temp_max_days",
     "type": "number",
     "required": false
    },
    {
     "name": "links_enabled",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/storage#put-v1-admin-storage-drive-settings"
  },
  {
   "section": "admin",
   "resource": "sites",
   "method": "GET",
   "path": "/v1/admin/sites/settings",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/sites/settings",
   "summary": "Who may create sites in this tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `sites.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sites#get-v1-admin-sites-settings"
  },
  {
   "section": "admin",
   "resource": "sites",
   "method": "PUT",
   "path": "/v1/admin/sites/settings",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/sites/settings",
   "summary": "Update the settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `sites.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "creation",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/sites#put-v1-admin-sites-settings"
  },
  {
   "section": "admin",
   "resource": "sites",
   "method": "GET",
   "path": "/v1/admin/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/sites",
   "summary": "Every site in the tenant with its owners, members, pages and library size",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `sites.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sites#get-v1-admin-sites"
  },
  {
   "section": "admin",
   "resource": "sites",
   "method": "POST",
   "path": "/v1/admin/sites/:id/owners",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/sites/:id/owners",
   "summary": "Make a tenant user an owner of a site (user_id; defaults to the calling admin)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `sites.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/sites#post-v1-admin-sites-id-owners"
  },
  {
   "section": "admin",
   "resource": "sites",
   "method": "GET",
   "path": "/v1/admin/sites/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/sites/:id/members",
   "summary": "List members of a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `sites.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sites#get-v1-admin-sites-id-members"
  },
  {
   "section": "admin",
   "resource": "sites",
   "method": "PUT",
   "path": "/v1/admin/sites/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/sites/:id/members",
   "summary": "Update the members of a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `sites.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "type",
     "type": "string: \"user\" \\| \"group\"",
     "required": false
    },
    {
     "name": "role",
     "type": "string",
     "required": false
    },
    {
     "name": "id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/sites#put-v1-admin-sites-id-members"
  },
  {
   "section": "admin",
   "resource": "sites",
   "method": "DELETE",
   "path": "/v1/admin/sites/:id/members/:type/:pid",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/sites/:id/members/:type/:pid",
   "summary": "Delete a member",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `sites.admin.manage`."
   ],
   "params": [
    "id",
    "type",
    "pid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sites#delete-v1-admin-sites-id-members-type-pid"
  },
  {
   "section": "admin",
   "resource": "sites",
   "method": "DELETE",
   "path": "/v1/admin/sites/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/sites/:id",
   "summary": "Delete a site (its libraries' files are purged by Drive after the bin period)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `sites.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/sites#delete-v1-admin-sites-id"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "POST",
   "path": "/v1/admin/rmm/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/sites",
   "summary": "Create an RMM site. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "client_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-sites#post-v1-admin-rmm-sites"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "PUT",
   "path": "/v1/admin/rmm/sites/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/sites/:id",
   "summary": "Update an RMM site. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "client_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-sites#put-v1-admin-rmm-sites-id"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "DELETE",
   "path": "/v1/admin/rmm/sites/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/sites/:id",
   "summary": "Delete an RMM site. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-sites#delete-v1-admin-rmm-sites-id"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "POST",
   "path": "/v1/admin/rmm/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/groups",
   "summary": "Create an RMM device group within a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "site_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-sites#post-v1-admin-rmm-groups"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "PUT",
   "path": "/v1/admin/rmm/groups/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/groups/:id",
   "summary": "Update an RMM device group",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-sites#put-v1-admin-rmm-groups-id"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "DELETE",
   "path": "/v1/admin/rmm/groups/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/groups/:id",
   "summary": "Delete an RMM device group",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-sites#delete-v1-admin-rmm-groups-id"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "GET",
   "path": "/v1/admin/rmm/enrollment-keys",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/enrollment-keys",
   "summary": "List RMM device enrollment keys",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-sites#get-v1-admin-rmm-enrollment-keys"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "POST",
   "path": "/v1/admin/rmm/enrollment-keys",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/enrollment-keys",
   "summary": "Create an RMM device enrollment key",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "display_name",
     "type": "string",
     "required": false
    },
    {
     "name": "site_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "group_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "device_type",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/rmm-sites#post-v1-admin-rmm-enrollment-keys"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "PUT",
   "path": "/v1/admin/rmm/enrollment-keys/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/enrollment-keys/:id",
   "summary": "Rename an enrollment key",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "display_name",
     "type": "string",
     "required": true
    }
   ],
   "docs": "/developers/reference/admin/rmm-sites#put-v1-admin-rmm-enrollment-keys-id"
  },
  {
   "section": "admin",
   "resource": "rmm-sites",
   "method": "DELETE",
   "path": "/v1/admin/rmm/enrollment-keys/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/rmm/enrollment-keys/:id",
   "summary": "Revoke an enrollment key",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.enrollment.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/rmm-sites#delete-v1-admin-rmm-enrollment-keys-id"
  },
  {
   "section": "admin",
   "resource": "deletion",
   "method": "GET",
   "path": "/v1/admin/tenant/delete-preview",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/delete-preview",
   "summary": "Preview what would be deleted if this tenant were purged",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/deletion#get-v1-admin-tenant-delete-preview"
  },
  {
   "section": "admin",
   "resource": "deletion",
   "method": "POST",
   "path": "/v1/admin/tenant/delete-request",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/delete-request",
   "summary": "Request permanent deletion of this tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "confirm_text",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/deletion#post-v1-admin-tenant-delete-request"
  },
  {
   "section": "admin",
   "resource": "deletion",
   "method": "GET",
   "path": "/v1/admin/tenant/delete-confirm",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/delete-confirm",
   "summary": "Confirm a pending tenant deletion via emailed token",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [
    "token"
   ],
   "body": [],
   "docs": "/developers/reference/admin/deletion#get-v1-admin-tenant-delete-confirm"
  },
  {
   "section": "admin",
   "resource": "deletion",
   "method": "POST",
   "path": "/v1/admin/tenant/delete-cancel",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/delete-cancel",
   "summary": "Cancel a pending tenant deletion request",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/deletion#post-v1-admin-tenant-delete-cancel"
  },
  {
   "section": "admin",
   "resource": "deletion",
   "method": "GET",
   "path": "/v1/admin/tenant/delete-status",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/delete-status",
   "summary": "Check for an active deletion request on this tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/deletion#get-v1-admin-tenant-delete-status"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "GET",
   "path": "/v1/admin/psa/templates",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/templates",
   "summary": "List PSA email templates",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#get-v1-admin-psa-templates"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/templates",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/templates",
   "summary": "Create a PSA email template",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "subject",
     "type": "any",
     "required": false
    },
    {
     "name": "body",
     "type": "any",
     "required": true
    },
    {
     "name": "category",
     "type": "any",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-templates"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/templates/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/templates/:id",
   "summary": "Update a PSA email template",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "subject",
     "type": "any",
     "required": false
    },
    {
     "name": "body",
     "type": "any",
     "required": false
    },
    {
     "name": "category",
     "type": "any",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-templates-id"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/templates/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/templates/:id/delete",
   "summary": "Delete a PSA email template",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-templates-id-delete"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "GET",
   "path": "/v1/admin/psa/statuses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/statuses",
   "summary": "List PSA statuses with their behaviours and ticket counts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#get-v1-admin-psa-statuses"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/statuses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/statuses",
   "summary": "Add a PSA status. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-statuses"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/statuses/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/statuses/:id",
   "summary": "Update a PSA status. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "group_key",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": false
    },
    {
     "name": "sort_order",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-statuses-id"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/statuses/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/statuses/:id/delete",
   "summary": "Delete a PSA status. Requires the GLOBAL_ADMIN role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "move_to",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-statuses-id-delete"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "GET",
   "path": "/v1/admin/psa/workflows",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/workflows",
   "summary": "List PSA workflow rules",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#get-v1-admin-psa-workflows"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/workflows",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/workflows",
   "summary": "Create a PSA workflow rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "trigger_event",
     "type": "string",
     "required": false
    },
    {
     "name": "trigger_config",
     "type": "object",
     "required": false
    },
    {
     "name": "conditions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "match_mode",
     "type": "string",
     "required": false
    },
    {
     "name": "stop_further",
     "type": "any",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-workflows"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/workflows/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/workflows/:id",
   "summary": "Update a PSA workflow rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    },
    {
     "name": "sort_order",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-workflows-id"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/workflows/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/workflows/:id/delete",
   "summary": "Delete a PSA workflow rule and its run log",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-workflows-id-delete"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/workflow-test",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/workflow-test",
   "summary": "Dry-run a PSA workflow rule against a ticket",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "rule",
     "type": "any",
     "required": false
    },
    {
     "name": "ticket_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-workflow-test"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "GET",
   "path": "/v1/admin/psa/workflow-runs",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/workflow-runs",
   "summary": "Recent PSA workflow runs (last 30 days)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [
    "workflow_id",
    "errors",
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/admin/psa#get-v1-admin-psa-workflow-runs"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "GET",
   "path": "/v1/admin/psa/sla",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/sla",
   "summary": "PSA business hours and SLA policies",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#get-v1-admin-psa-sla"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/sla/hours",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/sla/hours",
   "summary": "Add PSA business hours",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "timezone",
     "type": "any",
     "required": false
    },
    {
     "name": "schedule",
     "type": "any",
     "required": false
    },
    {
     "name": "holidays",
     "type": "array of any",
     "required": false
    },
    {
     "name": "bank_holidays",
     "type": "string: \"england-and-wales\" \\| \"scotland\" \\| \"northern-ireland\"",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-sla-hours"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/sla/hours/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/sla/hours/:id",
   "summary": "Update PSA business hours",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "timezone",
     "type": "any",
     "required": false
    },
    {
     "name": "schedule",
     "type": "any",
     "required": false
    },
    {
     "name": "holidays",
     "type": "array of any",
     "required": false
    },
    {
     "name": "bank_holidays",
     "type": "string: \"england-and-wales\" \\| \"scotland\" \\| \"northern-ireland\"",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-sla-hours-id"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/sla/hours/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/sla/hours/:id/delete",
   "summary": "Delete PSA business hours",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-sla-hours-id-delete"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/sla/policies",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/sla/policies",
   "summary": "Add a PSA SLA policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "targets",
     "type": "array of any",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    },
    {
     "name": "business_hours_id",
     "type": "number",
     "required": false
    },
    {
     "name": "warn_percent",
     "type": "integer",
     "required": false
    },
    {
     "name": "customer_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "queue_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "type_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-sla-policies"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/sla/policies/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/sla/policies/:id",
   "summary": "Update a PSA SLA policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    },
    {
     "name": "sort_order",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-sla-policies-id"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/sla/policies/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/sla/policies/:id/delete",
   "summary": "Delete a PSA SLA policy",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-sla-policies-id-delete"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "GET",
   "path": "/v1/admin/psa/types",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/types",
   "summary": "List PSA ticket types",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#get-v1-admin-psa-types"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/types",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/types",
   "summary": "Add a PSA ticket type",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-types"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/types/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/types/:id",
   "summary": "Rename, turn on/off or reorder a PSA ticket type",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    },
    {
     "name": "sort_order",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-types-id"
  },
  {
   "section": "admin",
   "resource": "psa",
   "method": "POST",
   "path": "/v1/admin/psa/types/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/admin/psa/types/:id/delete",
   "summary": "Delete a PSA ticket type",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `psa.admin.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/admin/psa#post-v1-admin-psa-types-id-delete"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v1/app/rmm/version",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/version",
   "summary": "Current versions",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v1-app-rmm-version"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v1/app/rmm/version/agent",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent",
   "summary": "Current agent version",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v1-app-rmm-version-agent"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v1/app/rmm/version/agent/linux",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/linux",
   "summary": "Current Linux agent version and checksum",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v1-app-rmm-version-agent-linux"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v1/app/rmm/version/agent/windows",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/windows",
   "summary": "Current Windows agent version and checksum",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v1-app-rmm-version-agent-windows"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v1/app/rmm/version/agent/macos",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/macos",
   "summary": "Current macOS agent version and checksum",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v1-app-rmm-version-agent-macos"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v1/app/rmm/version/agent/remote",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/remote",
   "summary": "Current Remote agent version and checksum",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v1-app-rmm-version-agent-remote"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v1/app/rmm/version/agent/legacy",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/legacy",
   "summary": "Current version for old agents",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v1-app-rmm-version-agent-legacy"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v1/app/rmm/version/server",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/server",
   "summary": "Current server version",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v1-app-rmm-version-server"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "POST",
   "path": "/v1/app/rmm/release/agent/:platform",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/release/agent/:platform",
   "summary": "Publish an agent release",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "platform"
   ],
   "query": [],
   "body": [
    {
     "name": "version",
     "type": "string",
     "required": true
    },
    {
     "name": "sha256",
     "type": "string",
     "required": true
    }
   ],
   "docs": "/developers/reference/rmm/version#post-v1-app-rmm-release-agent-platform"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v1/app/rmm/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/sites",
   "summary": "List sites (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v1-app-rmm-sites"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v1/app/rmm/deivce/:deivceid:",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/deivce/:deivceid:",
   "summary": "Get a device (legacy, misspelt path)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "deivceid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v1-app-rmm-deivce-deivceid"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v1/app/rmm/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/groups",
   "summary": "List groups in a site (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v1-app-rmm-groups"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v1/app/rmm/devices",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/devices",
   "summary": "List devices in a group (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "group_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v1-app-rmm-devices"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v1/app/rmm/device/utilization",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/device/utilization",
   "summary": "A device's utilisation (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v1-app-rmm-device-utilization"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v1/app/rmm/device/command",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/device/command",
   "summary": "Send a command to a device (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "command",
     "type": "any",
     "required": true
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v1-app-rmm-device-command"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v1/app/rmm/device/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/device/:id",
   "summary": "Get a device (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v1-app-rmm-device-id"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v1/app/rmm/group/commands/list",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/group/commands/list",
   "summary": "Recent commands in a group (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "group_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v1-app-rmm-group-commands-list"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v1/app/rmm/device/commands/list",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/device/commands/list",
   "summary": "A device's recent commands (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v1-app-rmm-device-commands-list"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "GET",
   "path": "/v1/app/rmm/scripts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/scripts",
   "summary": "List scripts (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/scripts#get-v1-app-rmm-scripts"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "GET",
   "path": "/v1/app/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/scripts/:id",
   "summary": "Get a script (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/scripts#get-v1-app-rmm-scripts-id"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "POST",
   "path": "/v1/app/rmm/scripts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/scripts",
   "summary": "Create a script (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM.",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "language",
     "type": "any",
     "required": true
    },
    {
     "name": "script_body",
     "type": "any",
     "required": true
    },
    {
     "name": "timeout_seconds",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/scripts#post-v1-app-rmm-scripts"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "PUT",
   "path": "/v1/app/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/scripts/:id",
   "summary": "Update a script (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM.",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "language",
     "type": "any",
     "required": false
    },
    {
     "name": "script_body",
     "type": "any",
     "required": false
    },
    {
     "name": "timeout_seconds",
     "type": "array of any",
     "required": false
    },
    {
     "name": "is_enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/scripts#put-v1-app-rmm-scripts-id"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "DELETE",
   "path": "/v1/app/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/scripts/:id",
   "summary": "Delete a script (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM.",
    "Permission (any of): `rmm.scripts.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/scripts#delete-v1-app-rmm-scripts-id"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "POST",
   "path": "/v1/app/rmm/scripts/run",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/scripts/run",
   "summary": "Run a script on a device (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "script_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "script_args",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/scripts#post-v1-app-rmm-scripts-run"
  },
  {
   "section": "rmm",
   "resource": "remote",
   "method": "POST",
   "path": "/v1/app/rmm/device/terminal/session",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/rmm/device/terminal/session",
   "summary": "Open a remote terminal (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/rmm/remote#post-v1-app-rmm-device-terminal-session"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v2/app/rmm/version/agent",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/version/agent",
   "summary": "Current agent version",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v2-app-rmm-version-agent"
  },
  {
   "section": "rmm",
   "resource": "version",
   "method": "GET",
   "path": "/v2/app/rmm/version",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/version",
   "summary": "Current versions",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/version#get-v2-app-rmm-version"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v2/app/rmm/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/sites",
   "summary": "List sites and groups",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v2-app-rmm-sites"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/groups",
   "summary": "List groups in a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-groups"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v2/app/rmm/groups/:siteId",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/groups/:siteId",
   "summary": "Fetch groups for a specific site (tenant-scoped)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "siteId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v2-app-rmm-groups-siteid"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/devices",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/devices",
   "summary": "Body { site_id?, group_id?",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-devices"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v2/app/rmm/device/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/:id",
   "summary": "Get a device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v2-app-rmm-device-id"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "PUT",
   "path": "/v2/app/rmm/device/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/:id",
   "summary": "Update editable device fields",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "display_name",
     "type": "string",
     "required": false
    },
    {
     "name": "device_type",
     "type": "string",
     "required": false
    },
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "group_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#put-v2-app-rmm-device-id"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "DELETE",
   "path": "/v2/app/rmm/device/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/:id",
   "summary": "Remove a device from the dashboard immediately (hidden from every list/ get below) but defer the actual hard delete: queue the uninstall script, mark the dev…",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#delete-v2-app-rmm-device-id"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/device/:id/proxmox-config",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/:id/proxmox-config",
   "summary": "Save a Proxmox VE host's API login",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-device-id-proxmox-config"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/device/:id/pbs-config",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/:id/pbs-config",
   "summary": "Save a Proxmox Backup Server's API login",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-device-id-pbs-config"
  },
  {
   "section": "rmm",
   "resource": "virtualisation",
   "method": "GET",
   "path": "/v2/app/rmm/hypervisor-hosts",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/hypervisor-hosts",
   "summary": "Tenant-wide list of devices flagged as Proxmox/PBS hosts, for the link picker on a device's Hypervisor tab and the site Backups tab",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/virtualisation#get-v2-app-rmm-hypervisor-hosts"
  },
  {
   "section": "rmm",
   "resource": "virtualisation",
   "method": "GET",
   "path": "/v2/app/rmm/hypervisor-links",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/hypervisor-links",
   "summary": "List PVE ↔ PBS links",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/virtualisation#get-v2-app-rmm-hypervisor-links"
  },
  {
   "section": "rmm",
   "resource": "virtualisation",
   "method": "POST",
   "path": "/v2/app/rmm/hypervisor-links",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/hypervisor-links",
   "summary": "Link a PVE host to its backup server",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "proxmox_device_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "pbs_device_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/rmm/virtualisation#post-v2-app-rmm-hypervisor-links"
  },
  {
   "section": "rmm",
   "resource": "virtualisation",
   "method": "DELETE",
   "path": "/v2/app/rmm/hypervisor-links/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/hypervisor-links/:id",
   "summary": "Remove a PVE ↔ PBS link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/virtualisation#delete-v2-app-rmm-hypervisor-links-id"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v2/app/rmm/device/:id/backup-status",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/:id/backup-status",
   "summary": "ComputeGuestBackupPosture / summariseProxmoxHealth live in services/proxmox-health.js (shared with the check engine)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v2-app-rmm-device-id-backup-status"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v2/app/rmm/sites/:siteId/backup-coverage",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/sites/:siteId/backup-coverage",
   "summary": "Cross-references this site's Proxmox hosts against their linked PBS servers (which may live in a different site — see note above) to compute per-guest backup…",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "siteId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v2-app-rmm-sites-siteid-backup-coverage"
  },
  {
   "section": "rmm",
   "resource": "virtualisation",
   "method": "GET",
   "path": "/v2/app/rmm/virtualisation",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/virtualisation",
   "summary": "Everything RMM2's Virtualisation view needs in one call: each Proxmox host with its live guests (status, CPU, RAM from the agent's inventory) and each guest'…",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [
    "site_id"
   ],
   "body": [],
   "docs": "/developers/reference/rmm/virtualisation#get-v2-app-rmm-virtualisation"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/device/:id/fetch-log",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/:id/fetch-log",
   "summary": "Queues a fetch_log command — the agent reads its own local agent.log (tail, capped at ~200KB) and returns it as the command's stdout",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-device-id-fetch-log"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/device/:id/refresh",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/:id/refresh",
   "summary": "Queues a refresh_data command — the agent immediately re-posts heartbeat/utilization/full inventory instead of waiting for its normal 60s/30min timers",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-device-id-refresh"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/device/maintenance/toggle",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/maintenance/toggle",
   "summary": "Toggle maintenance mode for a device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-device-maintenance-toggle"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/device/command",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/command",
   "summary": "Send a command to a device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "command",
     "type": "any",
     "required": true
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-device-command"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/device/commands/list",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/commands/list",
   "summary": "A device's recent commands and their results",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-device-commands-list"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v2/app/rmm/device/commands/:id/output",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/commands/:id/output",
   "summary": "Output of a command archived to BRM-Blob (services/rmm-history.js); the list endpoints return output_archived = 1 and no output for those",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v2-app-rmm-device-commands-id-output"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v2/app/rmm/device/utilization/history",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/utilization/history",
   "summary": "Utilisation for a device over a date range (YYYY-MM-DD), including days archived to BRM-Blob",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [
    "device_id",
    "from",
    "to"
   ],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v2-app-rmm-device-utilization-history"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "POST",
   "path": "/v2/app/rmm/group/commands/list",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/group/commands/list",
   "summary": "Command log for RMM2's site/group selection: body { site_id?, group_id?, limit } (neither = every device)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "limit",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/devices#post-v2-app-rmm-group-commands-list"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "GET",
   "path": "/v2/app/rmm/scripts",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/scripts",
   "summary": "List scripts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/scripts#get-v2-app-rmm-scripts"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "GET",
   "path": "/v2/app/rmm/script-categories",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/script-categories",
   "summary": "List script folders",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/scripts#get-v2-app-rmm-script-categories"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "GET",
   "path": "/v2/app/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/scripts/:id",
   "summary": "Get a script",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/scripts#get-v2-app-rmm-scripts-id"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "POST",
   "path": "/v2/app/rmm/scripts",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/scripts",
   "summary": "Create a script",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "language",
     "type": "any",
     "required": true
    },
    {
     "name": "script_body",
     "type": "any",
     "required": true
    },
    {
     "name": "timeout_seconds",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/scripts#post-v2-app-rmm-scripts"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "PUT",
   "path": "/v2/app/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/scripts/:id",
   "summary": "Update a script",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "language",
     "type": "any",
     "required": false
    },
    {
     "name": "script_body",
     "type": "any",
     "required": false
    },
    {
     "name": "timeout_seconds",
     "type": "array of any",
     "required": false
    },
    {
     "name": "is_enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/scripts#put-v2-app-rmm-scripts-id"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "DELETE",
   "path": "/v2/app/rmm/scripts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/scripts/:id",
   "summary": "Delete a script",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/scripts#delete-v2-app-rmm-scripts-id"
  },
  {
   "section": "rmm",
   "resource": "scripts",
   "method": "POST",
   "path": "/v2/app/rmm/scripts/run",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/scripts/run",
   "summary": "Run a script on a device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "script_id",
     "type": "number",
     "required": true
    },
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "script_args",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/scripts#post-v2-app-rmm-scripts-run"
  },
  {
   "section": "rmm",
   "resource": "devices",
   "method": "GET",
   "path": "/v2/app/rmm/enrollment/keys",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/enrollment/keys",
   "summary": "List enrolment keys (for install commands)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/devices#get-v2-app-rmm-enrollment-keys"
  },
  {
   "section": "rmm",
   "resource": "remote",
   "method": "POST",
   "path": "/v2/app/rmm/device/terminal/session",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/terminal/session",
   "summary": "Open a remote terminal",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/rmm/remote#post-v2-app-rmm-device-terminal-session"
  },
  {
   "section": "rmm",
   "resource": "remote",
   "method": "POST",
   "path": "/v2/app/rmm/device/vnc/session",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm/device/vnc/session",
   "summary": "Open a remote screen (VNC)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/rmm/remote#post-v2-app-rmm-device-vnc-session"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "GET",
   "path": "/v2/app/rmm-apps",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps",
   "summary": "?site_id=&group_id= (RMM2's selection) narrows the device counts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.view`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#get-v2-app-rmm-apps"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "GET",
   "path": "/v2/app/rmm-apps/search",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/search",
   "summary": "Search package sources",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.view`."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#get-v2-app-rmm-apps-search"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "GET",
   "path": "/v2/app/rmm-apps/lookup",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/lookup",
   "summary": "Check an exact package name",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.view`."
   ],
   "params": [],
   "query": [
    "manager",
    "id"
   ],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#get-v2-app-rmm-apps-lookup"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "GET",
   "path": "/v2/app/rmm-apps/targets",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/targets",
   "summary": "Sites, groups and devices an app can be assigned to",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.view`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#get-v2-app-rmm-apps-targets"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "POST",
   "path": "/v2/app/rmm-apps/apps",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps",
   "summary": "Add an app to the catalogue",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "publisher",
     "type": "any",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "sources",
     "type": "array of any",
     "required": false
    },
    {
     "name": "assignments",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-apps#post-v2-app-rmm-apps-apps"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "GET",
   "path": "/v2/app/rmm-apps/apps/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps/:id",
   "summary": "Get an app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.view`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#get-v2-app-rmm-apps-apps-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "PUT",
   "path": "/v2/app/rmm-apps/apps/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps/:id",
   "summary": "Update an app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "publisher",
     "type": "any",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "sources",
     "type": "array of any",
     "required": false
    },
    {
     "name": "assignments",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-apps#put-v2-app-rmm-apps-apps-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "DELETE",
   "path": "/v2/app/rmm-apps/apps/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps/:id",
   "summary": "Remove an app from the catalogue",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#delete-v2-app-rmm-apps-apps-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "POST",
   "path": "/v2/app/rmm-apps/apps/:id/installers",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps/:id/installers",
   "summary": "Start uploading an installer (Windows MSI/EXE)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "file_name",
     "type": "string",
     "required": false
    },
    {
     "name": "size",
     "type": "integer",
     "required": false
    },
    {
     "name": "version",
     "type": "any",
     "required": false
    },
    {
     "name": "args",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-apps#post-v2-app-rmm-apps-apps-id-installers"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "PUT",
   "path": "/v2/app/rmm-apps/apps/:id/installers/:iid/parts/:n",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps/:id/installers/:iid/parts/:n",
   "summary": "Upload one part of an installer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [
    "id",
    "iid",
    "n"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#put-v2-app-rmm-apps-apps-id-installers-iid-parts-n"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "POST",
   "path": "/v2/app/rmm-apps/apps/:id/installers/:iid/complete",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps/:id/installers/:iid/complete",
   "summary": "Finish an installer upload",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [
    "id",
    "iid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#post-v2-app-rmm-apps-apps-id-installers-iid-complete"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "DELETE",
   "path": "/v2/app/rmm-apps/apps/:id/installers/:iid",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps/:id/installers/:iid",
   "summary": "Delete an uploaded installer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [
    "id",
    "iid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#delete-v2-app-rmm-apps-apps-id-installers-iid"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "POST",
   "path": "/v2/app/rmm-apps/apps/:id/sync",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/apps/:id/sync",
   "summary": "Push an app's assignments to devices now",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#post-v2-app-rmm-apps-apps-id-sync"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "GET",
   "path": "/v2/app/rmm-apps/device/:deviceId",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/device/:deviceId",
   "summary": "A device's managed apps and their state",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.view`."
   ],
   "params": [
    "deviceId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#get-v2-app-rmm-apps-device-deviceid"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "POST",
   "path": "/v2/app/rmm-apps/device/:deviceId/install",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/device/:deviceId/install",
   "summary": "Install an app on a device once",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.deploy`."
   ],
   "params": [
    "deviceId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#post-v2-app-rmm-apps-device-deviceid-install"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "POST",
   "path": "/v2/app/rmm-apps/device/:deviceId/uninstall",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/device/:deviceId/uninstall",
   "summary": "Uninstall an app from a device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.deploy`."
   ],
   "params": [
    "deviceId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#post-v2-app-rmm-apps-device-deviceid-uninstall"
  },
  {
   "section": "rmm",
   "resource": "rmm-apps",
   "method": "DELETE",
   "path": "/v2/app/rmm-apps/device/:deviceId/apps/:appId",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-apps/device/:deviceId/apps/:appId",
   "summary": "Clear an app's state on a device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.apps.manage`."
   ],
   "params": [
    "deviceId",
    "appId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-apps#delete-v2-app-rmm-apps-device-deviceid-apps-appid"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "GET",
   "path": "/v2/app/rmm-backups",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups",
   "summary": "Backup overview",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-backups#get-v2-app-rmm-backups"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "GET",
   "path": "/v2/app/rmm-backups/devices/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/devices/:id",
   "summary": "A device's backup jobs and history",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-backups#get-v2-app-rmm-backups-devices-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "POST",
   "path": "/v2/app/rmm-backups/devices/:id/jobs",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/devices/:id/jobs",
   "summary": "Create a backup job",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.backups.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-backups#post-v2-app-rmm-backups-devices-id-jobs"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "PUT",
   "path": "/v2/app/rmm-backups/jobs/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/jobs/:id",
   "summary": "Update a backup job",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.backups.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-backups#put-v2-app-rmm-backups-jobs-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "DELETE",
   "path": "/v2/app/rmm-backups/jobs/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/jobs/:id",
   "summary": "Delete a backup job",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.backups.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-backups#delete-v2-app-rmm-backups-jobs-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "POST",
   "path": "/v2/app/rmm-backups/jobs/:id/run",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/jobs/:id/run",
   "summary": "Back up now",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.backups.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "full",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-backups#post-v2-app-rmm-backups-jobs-id-run"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "GET",
   "path": "/v2/app/rmm-backups/runs/:id/browse",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/runs/:id/browse",
   "summary": "Browse the files in a backup",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [
    "path"
   ],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-backups#get-v2-app-rmm-backups-runs-id-browse"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "GET",
   "path": "/v2/app/rmm-backups/runs/:id/download",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/runs/:id/download",
   "summary": "Download a backup",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.backups.download`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-backups#get-v2-app-rmm-backups-runs-id-download"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "DELETE",
   "path": "/v2/app/rmm-backups/runs/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/runs/:id",
   "summary": "Delete a backup",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.backups.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-backups#delete-v2-app-rmm-backups-runs-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-backups",
   "method": "POST",
   "path": "/v2/app/rmm-backups/runs/:id/restore",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-backups/runs/:id/restore",
   "summary": "Restore from a backup",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.backups.restore`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "target_device_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "paths",
     "type": "array of any",
     "required": false
    },
    {
     "name": "destination",
     "type": "string",
     "required": false
    },
    {
     "name": "folder",
     "type": "any",
     "required": false
    },
    {
     "name": "overwrite",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-backups#post-v2-app-rmm-backups-runs-id-restore"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v2/app/rmm-checks/checks",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks",
   "summary": "List monitoring checks",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#get-v2-app-rmm-checks-checks"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v2/app/rmm-checks/checks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/:id",
   "summary": "Get a single check with its actions and assignments",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#get-v2-app-rmm-checks-checks-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v2/app/rmm-checks/checks",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks",
   "summary": "Create a monitoring check",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "check_type",
     "type": "string",
     "required": true
    },
    {
     "name": "check_config",
     "type": "any",
     "required": true
    },
    {
     "name": "severity",
     "type": "any",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "assignments",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-checks#post-v2-app-rmm-checks-checks"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "PUT",
   "path": "/v2/app/rmm-checks/checks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/:id",
   "summary": "Update a check. Requires an active RMM license",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "check_type",
     "type": "string",
     "required": false
    },
    {
     "name": "check_config",
     "type": "any",
     "required": false
    },
    {
     "name": "severity",
     "type": "any",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "assignments",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-checks#put-v2-app-rmm-checks-checks-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v2/app/rmm-checks/checks/:id/toggle",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/:id/toggle",
   "summary": "Toggle a check's enabled/disabled state",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#post-v2-app-rmm-checks-checks-id-toggle"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "DELETE",
   "path": "/v2/app/rmm-checks/checks/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/:id",
   "summary": "Delete a check. Requires an active RMM license",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#delete-v2-app-rmm-checks-checks-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v2/app/rmm-checks/device/:deviceId/checks",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/:deviceId/checks",
   "summary": "List checks that apply to a device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "deviceId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#get-v2-app-rmm-checks-device-deviceid-checks"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v2/app/rmm-checks/device/:deviceId/exclude/:checkId",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/:deviceId/exclude/:checkId",
   "summary": "Toggle exclusion of a check for a specific device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "deviceId",
    "checkId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#post-v2-app-rmm-checks-device-deviceid-exclude-checkid"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v2/app/rmm-checks/device/:deviceId/assign/:checkId",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/:deviceId/assign/:checkId",
   "summary": "Assign an existing check directly to a device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "deviceId",
    "checkId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#post-v2-app-rmm-checks-device-deviceid-assign-checkid"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v2/app/rmm-checks/alerts",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts",
   "summary": "List recent alert log entries",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#get-v2-app-rmm-checks-alerts"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v2/app/rmm-checks/alerts/:id/resolve",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/:id/resolve",
   "summary": "Manually resolve (dismiss) a firing alert",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#post-v2-app-rmm-checks-alerts-id-resolve"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "POST",
   "path": "/v2/app/rmm-checks/alerts/acknowledge",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/acknowledge",
   "summary": "Acknowledge firing alerts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "all",
     "type": "any",
     "required": false
    },
    {
     "name": "undo",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-checks#post-v2-app-rmm-checks-alerts-acknowledge"
  },
  {
   "section": "rmm",
   "resource": "rmm-checks",
   "method": "GET",
   "path": "/v2/app/rmm-checks/alerts/active",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/active",
   "summary": "List currently firing alerts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-checks#get-v2-app-rmm-checks-alerts-active"
  },
  {
   "section": "rmm",
   "resource": "rmm-dashboards",
   "method": "GET",
   "path": "/v2/app/rmm-dashboards",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-dashboards",
   "summary": "List dashboards",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-dashboards#get-v2-app-rmm-dashboards"
  },
  {
   "section": "rmm",
   "resource": "rmm-dashboards",
   "method": "POST",
   "path": "/v2/app/rmm-dashboards/query",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-dashboards/query",
   "summary": "?site_id=&group_id= — RMM2's site/group selection; every widget follows it (sources with no site, like network scan findings, cover the organisation)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-dashboards#post-v2-app-rmm-dashboards-query"
  },
  {
   "section": "rmm",
   "resource": "rmm-dashboards",
   "method": "POST",
   "path": "/v2/app/rmm-dashboards/values",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-dashboards/values",
   "summary": "Values a field can take (for widget filters)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "source",
     "type": "any",
     "required": false
    },
    {
     "name": "field",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-dashboards#post-v2-app-rmm-dashboards-values"
  },
  {
   "section": "rmm",
   "resource": "rmm-dashboards",
   "method": "POST",
   "path": "/v2/app/rmm-dashboards",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-dashboards",
   "summary": "Create a dashboard",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "template",
     "type": "any",
     "required": false
    },
    {
     "name": "widgets",
     "type": "array of any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-dashboards#post-v2-app-rmm-dashboards"
  },
  {
   "section": "rmm",
   "resource": "rmm-dashboards",
   "method": "PUT",
   "path": "/v2/app/rmm-dashboards/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-dashboards/:id",
   "summary": "Update a dashboard",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "shared",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-dashboards#put-v2-app-rmm-dashboards-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-dashboards",
   "method": "POST",
   "path": "/v2/app/rmm-dashboards/:id/duplicate",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-dashboards/:id/duplicate",
   "summary": "Copy a dashboard",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-dashboards#post-v2-app-rmm-dashboards-id-duplicate"
  },
  {
   "section": "rmm",
   "resource": "rmm-dashboards",
   "method": "DELETE",
   "path": "/v2/app/rmm-dashboards/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-dashboards/:id",
   "summary": "Delete a dashboard",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-dashboards#delete-v2-app-rmm-dashboards-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "GET",
   "path": "/v2/app/rmm-databases",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases",
   "summary": "Database servers overview",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-databases#get-v2-app-rmm-databases"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "GET",
   "path": "/v2/app/rmm-databases/devices/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/devices/:id",
   "summary": "A server's databases, backups and settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-databases#get-v2-app-rmm-databases-devices-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "PUT",
   "path": "/v2/app/rmm-databases/devices/:id/settings",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/devices/:id/settings",
   "summary": "Set a server's backup settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.databases.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "schedule_time",
     "type": "any",
     "required": false
    },
    {
     "name": "schedule_days",
     "type": "array of any",
     "required": false
    },
    {
     "name": "schedule_enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "include_system",
     "type": "boolean",
     "required": false
    },
    {
     "name": "databases",
     "type": "array of any",
     "required": false
    },
    {
     "name": "login_password",
     "type": "any",
     "required": false
    },
    {
     "name": "login_user",
     "type": "string",
     "required": false
    },
    {
     "name": "keep_daily",
     "type": "any",
     "required": false
    },
    {
     "name": "keep_weekly",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-databases#put-v2-app-rmm-databases-devices-id-settings"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "POST",
   "path": "/v2/app/rmm-databases/devices/:id/backup",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/devices/:id/backup",
   "summary": "Back up databases now",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.databases.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "databases",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-databases#post-v2-app-rmm-databases-devices-id-backup"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "POST",
   "path": "/v2/app/rmm-databases/devices/:id/refresh",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/devices/:id/refresh",
   "summary": "Refresh a server's overview now",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-databases#post-v2-app-rmm-databases-devices-id-refresh"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "GET",
   "path": "/v2/app/rmm-databases/backups/:id/download",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/backups/:id/download",
   "summary": "Download a database backup",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.databases.download`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-databases#get-v2-app-rmm-databases-backups-id-download"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "DELETE",
   "path": "/v2/app/rmm-databases/backups/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/backups/:id",
   "summary": "Delete a database backup",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.databases.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-databases#delete-v2-app-rmm-databases-backups-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "POST",
   "path": "/v2/app/rmm-databases/backups/:id/open",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/backups/:id/open",
   "summary": "Opening a backup to look at its data: like a download, it shows everything",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.databases.download`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "hours",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-databases#post-v2-app-rmm-databases-backups-id-open"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "DELETE",
   "path": "/v2/app/rmm-databases/mounts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/mounts/:id",
   "summary": "Close an opened backup",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.databases.download`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-databases#delete-v2-app-rmm-databases-mounts-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "POST",
   "path": "/v2/app/rmm-databases/mounts/:id/query",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/mounts/:id/query",
   "summary": "Browse an opened backup",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.databases.download`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "op",
     "type": "string: \"tables\" \\| \"rows\"",
     "required": false
    },
    {
     "name": "table",
     "type": "string",
     "required": false
    },
    {
     "name": "offset",
     "type": "integer",
     "required": false
    },
    {
     "name": "limit",
     "type": "integer",
     "required": false
    },
    {
     "name": "sort",
     "type": "string",
     "required": false
    },
    {
     "name": "dir",
     "type": "string",
     "required": false
    },
    {
     "name": "filter_col",
     "type": "string",
     "required": false
    },
    {
     "name": "filter",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-databases#post-v2-app-rmm-databases-mounts-id-query"
  },
  {
   "section": "rmm",
   "resource": "rmm-databases",
   "method": "GET",
   "path": "/v2/app/rmm-databases/mounts/:id/queries/:qid",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-databases/mounts/:id/queries/:qid",
   "summary": "Result of a browse request",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.databases.download`."
   ],
   "params": [
    "id",
    "qid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-databases#get-v2-app-rmm-databases-mounts-id-queries-qid"
  },
  {
   "section": "rmm",
   "resource": "rmm-logs",
   "method": "GET",
   "path": "/v2/app/rmm-logs",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs",
   "summary": "Log collectors and recent logs",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.logs.view`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-logs#get-v2-app-rmm-logs"
  },
  {
   "section": "rmm",
   "resource": "rmm-logs",
   "method": "GET",
   "path": "/v2/app/rmm-logs/search",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/search",
   "summary": "Search collected logs",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.logs.view`."
   ],
   "params": [],
   "query": [
    "to",
    "from",
    "max_sev",
    "device_id",
    "q",
    "source",
    "app"
   ],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-logs#get-v2-app-rmm-logs-search"
  },
  {
   "section": "rmm",
   "resource": "rmm-logs",
   "method": "PUT",
   "path": "/v2/app/rmm-logs/collectors/:deviceId",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/:deviceId",
   "summary": "Turn a device into a syslog collector",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.logs.manage`."
   ],
   "params": [
    "deviceId"
   ],
   "query": [],
   "body": [
    {
     "name": "udp_port",
     "type": "any",
     "required": false
    },
    {
     "name": "tcp_port",
     "type": "any",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-logs#put-v2-app-rmm-logs-collectors-deviceid"
  },
  {
   "section": "rmm",
   "resource": "rmm-logs",
   "method": "DELETE",
   "path": "/v2/app/rmm-logs/collectors/:deviceId",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/:deviceId",
   "summary": "Stop a syslog collector",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Permission (any of): `rmm.logs.manage`."
   ],
   "params": [
    "deviceId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-logs#delete-v2-app-rmm-logs-collectors-deviceid"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-monitor",
   "method": "GET",
   "path": "/v2/app/rmm-network-monitor/monitors",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-monitor/monitors",
   "summary": "List with 24h uptime and a 60-minute latency spark",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-monitor#get-v2-app-rmm-network-monitor-monitors"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-monitor",
   "method": "GET",
   "path": "/v2/app/rmm-network-monitor/monitors/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-monitor/monitors/:id",
   "summary": "Detail: interfaces (latest rates) + 24h reachability",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [
    "hours"
   ],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-monitor#get-v2-app-rmm-network-monitor-monitors-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-monitor",
   "method": "GET",
   "path": "/v2/app/rmm-network-monitor/monitors/:id/interfaces/:ifIndex",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-monitor/monitors/:id/interfaces/:ifIndex",
   "summary": "Traffic history for one port",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id",
    "ifIndex"
   ],
   "query": [
    "hours"
   ],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-monitor#get-v2-app-rmm-network-monitor-monitors-id-interfaces-ifindex"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-monitor",
   "method": "POST",
   "path": "/v2/app/rmm-network-monitor/monitors",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-monitor/monitors",
   "summary": "{ discovered_device_id } to adopt a discovered device, or { probe_device_id, ip_address, name } to add one by IP",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "discovered_device_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "probe_device_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "ip_address",
     "type": "any",
     "required": false
    },
    {
     "name": "check_ping",
     "type": "boolean",
     "required": false
    },
    {
     "name": "tcp_ports",
     "type": "array of any",
     "required": false
    },
    {
     "name": "snmp_enabled",
     "type": "any",
     "required": false
    },
    {
     "name": "snmp_version",
     "type": "string",
     "required": false
    },
    {
     "name": "snmp_community",
     "type": "any",
     "required": false
    },
    {
     "name": "snmp_v3",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-network-monitor#post-v2-app-rmm-network-monitor-monitors"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-monitor",
   "method": "PUT",
   "path": "/v2/app/rmm-network-monitor/monitors/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-monitor/monitors/:id",
   "summary": "Name, is_enabled, is_maintenance, check_ping, tcp_ports, snmp_enabled, snmp_version, snmp_community, snmp_v3",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "is_enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "is_maintenance",
     "type": "boolean",
     "required": false
    },
    {
     "name": "check_ping",
     "type": "any",
     "required": false
    },
    {
     "name": "tcp_ports",
     "type": "array of any",
     "required": false
    },
    {
     "name": "snmp_enabled",
     "type": "any",
     "required": false
    },
    {
     "name": "snmp_version",
     "type": "string",
     "required": false
    },
    {
     "name": "snmp_community",
     "type": "string",
     "required": false
    },
    {
     "name": "snmp_community_clear",
     "type": "any",
     "required": false
    },
    {
     "name": "snmp_v3",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-network-monitor#put-v2-app-rmm-network-monitor-monitors-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-monitor",
   "method": "DELETE",
   "path": "/v2/app/rmm-network-monitor/monitors/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-monitor/monitors/:id",
   "summary": "Delete a monitor",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-monitor#delete-v2-app-rmm-network-monitor-monitors-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "POST",
   "path": "/v2/app/rmm-network-probe/device/:id/promote",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/device/:id/promote",
   "summary": "Promote a device to a Network Probe",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-probe#post-v2-app-rmm-network-probe-device-id-promote"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "POST",
   "path": "/v2/app/rmm-network-probe/device/:id/demote",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/device/:id/demote",
   "summary": "Demote a device from Network Probe",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-probe#post-v2-app-rmm-network-probe-device-id-demote"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "GET",
   "path": "/v2/app/rmm-network-probe/device/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/device/:id",
   "summary": "Get a device's Network Probe status and configuration",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-probe#get-v2-app-rmm-network-probe-device-id"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "POST",
   "path": "/v2/app/rmm-network-probe/device/:id/config",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/device/:id/config",
   "summary": "Save a Network Probe's scan configuration",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "extra_subnets",
     "type": "array of any",
     "required": false
    },
    {
     "name": "snmp_community",
     "type": "any",
     "required": false
    },
    {
     "name": "is_enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "scan_interval_minutes",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-network-probe#post-v2-app-rmm-network-probe-device-id-config"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "POST",
   "path": "/v2/app/rmm-network-probe/device/:id/scan-now",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/device/:id/scan-now",
   "summary": "Trigger an immediate subnet scan",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-probe#post-v2-app-rmm-network-probe-device-id-scan-now"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "POST",
   "path": "/v2/app/rmm-network-probe/device/:id/ping",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/device/:id/ping",
   "summary": "Run an ad-hoc ping against a single host via a Network Probe",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "host",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/rmm/rmm-network-probe#post-v2-app-rmm-network-probe-device-id-ping"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "GET",
   "path": "/v2/app/rmm-network-probe/groups/:groupId/discovered-devices",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/groups/:groupId/discovered-devices",
   "summary": "List discovered (non-agent) devices for a site group",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "groupId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-probe#get-v2-app-rmm-network-probe-groups-groupid-discovered-devices"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "GET",
   "path": "/v2/app/rmm-network-probe/discovered-devices",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/discovered-devices",
   "summary": "Same as the group listing above, for RMM2's site/group selection: one group, a whole site, or (neither) every site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-probe#get-v2-app-rmm-network-probe-discovered-devices"
  },
  {
   "section": "rmm",
   "resource": "rmm-network-probe",
   "method": "GET",
   "path": "/v2/app/rmm-network-probe/discovered-device/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v2/app/rmm-network-probe/discovered-device/:id",
   "summary": "Get full detail for one discovered network device",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/rmm/rmm-network-probe#get-v2-app-rmm-network-probe-discovered-device-id"
  },
  {
   "section": "warden",
   "resource": "overview",
   "method": "GET",
   "path": "/api/me",
   "url": "https://<your-org>.brambleit.cloud/warden/api/me",
   "summary": "Who you are: the signed-in person and what they can do here",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/overview#get-api-me"
  },
  {
   "section": "warden",
   "resource": "overview",
   "method": "GET",
   "path": "/api/overview",
   "url": "https://<your-org>.brambleit.cloud/warden/api/overview",
   "summary": "Dashboard numbers",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/overview#get-api-overview"
  },
  {
   "section": "warden",
   "resource": "vulnerabilities",
   "method": "GET",
   "path": "/api/vulnerabilities",
   "url": "https://<your-org>.brambleit.cloud/warden/api/vulnerabilities",
   "summary": "List vulnerable packages",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "status",
    "severity",
    "fix_state",
    "kev",
    "device_id",
    "package",
    "search"
   ],
   "body": [],
   "docs": "/developers/reference/warden/vulnerabilities#get-api-vulnerabilities"
  },
  {
   "section": "warden",
   "resource": "vulnerabilities",
   "method": "GET",
   "path": "/api/vulnerabilities/:package",
   "url": "https://<your-org>.brambleit.cloud/warden/api/vulnerabilities/:package",
   "summary": "One package's findings across devices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "package"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/vulnerabilities#get-api-vulnerabilities-package"
  },
  {
   "section": "warden",
   "resource": "vulnerabilities",
   "method": "GET",
   "path": "/api/findings",
   "url": "https://<your-org>.brambleit.cloud/warden/api/findings",
   "summary": "List findings",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "status",
    "severity",
    "fix_state",
    "kev",
    "device_id",
    "package",
    "search"
   ],
   "body": [],
   "docs": "/developers/reference/warden/vulnerabilities#get-api-findings"
  },
  {
   "section": "warden",
   "resource": "vulnerabilities",
   "method": "POST",
   "path": "/api/findings/status",
   "url": "https://<your-org>.brambleit.cloud/warden/api/findings/status",
   "summary": "Accept or dismiss findings",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "status",
     "type": "string: \"open\" \\| \"accepted\" \\| \"false_positive\"",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/vulnerabilities#post-api-findings-status"
  },
  {
   "section": "warden",
   "resource": "devices",
   "method": "GET",
   "path": "/api/devices",
   "url": "https://<your-org>.brambleit.cloud/warden/api/devices",
   "summary": "List devices with their issues",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/devices#get-api-devices"
  },
  {
   "section": "warden",
   "resource": "devices",
   "method": "GET",
   "path": "/api/devices/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/devices/:id",
   "summary": "A device's findings, updates and history",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/devices#get-api-devices-id"
  },
  {
   "section": "warden",
   "resource": "scan",
   "method": "POST",
   "path": "/api/scan",
   "url": "https://<your-org>.brambleit.cloud/warden/api/scan",
   "summary": "Start a scan",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/scan#post-api-scan"
  },
  {
   "section": "warden",
   "resource": "scan",
   "method": "GET",
   "path": "/api/scan/status",
   "url": "https://<your-org>.brambleit.cloud/warden/api/scan/status",
   "summary": "Live progress for the header bar",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/scan#get-api-scan-status"
  },
  {
   "section": "warden",
   "resource": "scan",
   "method": "POST",
   "path": "/api/scan/cancel",
   "url": "https://<your-org>.brambleit.cloud/warden/api/scan/cancel",
   "summary": "Cancel the running scan (or one specific run)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "run_id",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/scan#post-api-scan-cancel"
  },
  {
   "section": "warden",
   "resource": "scan",
   "method": "GET",
   "path": "/api/scans",
   "url": "https://<your-org>.brambleit.cloud/warden/api/scans",
   "summary": "Scan history (Activity → Scans)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/warden/scan#get-api-scans"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "GET",
   "path": "/api/updates",
   "url": "https://<your-org>.brambleit.cloud/warden/api/updates",
   "summary": "Pending updates across devices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#get-api-updates"
  },
  {
   "section": "warden",
   "resource": "apps",
   "method": "GET",
   "path": "/api/apps",
   "url": "https://<your-org>.brambleit.cloud/warden/api/apps",
   "summary": "Application patching: outdated apps across the fleet, one row per app",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/apps#get-api-apps"
  },
  {
   "section": "warden",
   "resource": "apps",
   "method": "GET",
   "path": "/api/apps/inventory",
   "url": "https://<your-org>.brambleit.cloud/warden/api/apps/inventory",
   "summary": "Application inventory: every app found on devices (device_apps, built by the scanner from each device's report), one row per app, with how many devices have …",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/apps#get-api-apps-inventory"
  },
  {
   "section": "warden",
   "resource": "apps",
   "method": "GET",
   "path": "/api/apps/inventory/devices",
   "url": "https://<your-org>.brambleit.cloud/warden/api/apps/inventory/devices",
   "summary": "Devices that have an app",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "key"
   ],
   "body": [],
   "docs": "/developers/reference/warden/apps#get-api-apps-inventory-devices"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/approvals",
   "url": "https://<your-org>.brambleit.cloud/warden/api/approvals",
   "summary": "Approve or reject updates waiting for approval",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "items",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#post-api-approvals"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "GET",
   "path": "/api/jobs",
   "url": "https://<your-org>.brambleit.cloud/warden/api/jobs",
   "summary": "List patch jobs",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#get-api-jobs"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "GET",
   "path": "/api/jobs/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/jobs/:id",
   "summary": "Get a patch job with per-device results",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#get-api-jobs-id"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/jobs",
   "url": "https://<your-org>.brambleit.cloud/warden/api/jobs",
   "summary": "Start a patch job",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "update_class",
     "type": "string: \"security\" \\| \"all\" \\| \"selected\" \\| \"apps\"",
     "required": false
    },
    {
     "name": "reboot_policy",
     "type": "string: \"never\" \\| \"if_required\" \\| \"always\"",
     "required": false
    },
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "packages",
     "type": "array of any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "include_apps",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#post-api-jobs"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/patch/bulk",
   "url": "https://<your-org>.brambleit.cloud/warden/api/patch/bulk",
   "summary": "Patch everything that needs it",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "vuln_packages",
     "type": "array of any",
     "required": false
    },
    {
     "name": "update_packages",
     "type": "array of any",
     "required": false
    },
    {
     "name": "dry_run",
     "type": "any",
     "required": false
    },
    {
     "name": "reboot_policy",
     "type": "string: \"never\" \\| \"if_required\" \\| \"always\"",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#post-api-patch-bulk"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/jobs/:id/cancel",
   "url": "https://<your-org>.brambleit.cloud/warden/api/jobs/:id/cancel",
   "summary": "Cancel a patch job",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#post-api-jobs-id-cancel"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "GET",
   "path": "/api/policies",
   "url": "https://<your-org>.brambleit.cloud/warden/api/policies",
   "summary": "List patch policies",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#get-api-policies"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/policies",
   "url": "https://<your-org>.brambleit.cloud/warden/api/policies",
   "summary": "Create a patch policy",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "schedule_days",
     "type": "array of any",
     "required": false
    },
    {
     "name": "window_start",
     "type": "any",
     "required": false
    },
    {
     "name": "timezone",
     "type": "any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "scope_type",
     "type": "string: \"all\" \\| \"site\" \\| \"group\" \\| \"device\"",
     "required": false
    },
    {
     "name": "scope_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "update_class",
     "type": "string: \"all\" \\| \"apps\"",
     "required": false
    },
    {
     "name": "include_apps",
     "type": "array of any",
     "required": false
    },
    {
     "name": "windows_categories",
     "type": "array of any",
     "required": false
    },
    {
     "name": "approval_mode",
     "type": "string",
     "required": false
    },
    {
     "name": "window_minutes",
     "type": "integer",
     "required": false
    },
    {
     "name": "reboot_policy",
     "type": "string: \"never\" \\| \"if_required\" \\| \"always\"",
     "required": false
    },
    {
     "name": "exclude_packages",
     "type": "array of any",
     "required": false
    },
    {
     "name": "pre_script_id",
     "type": "number",
     "required": false
    },
    {
     "name": "post_script_id",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#post-api-policies"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "PUT",
   "path": "/api/policies/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/policies/:id",
   "summary": "Update a patch policy",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "schedule_days",
     "type": "array of any",
     "required": false
    },
    {
     "name": "window_start",
     "type": "any",
     "required": false
    },
    {
     "name": "timezone",
     "type": "any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "scope_type",
     "type": "string: \"all\" \\| \"site\" \\| \"group\" \\| \"device\"",
     "required": false
    },
    {
     "name": "scope_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "update_class",
     "type": "string: \"all\" \\| \"apps\"",
     "required": false
    },
    {
     "name": "include_apps",
     "type": "array of any",
     "required": false
    },
    {
     "name": "windows_categories",
     "type": "array of any",
     "required": false
    },
    {
     "name": "approval_mode",
     "type": "string",
     "required": false
    },
    {
     "name": "window_minutes",
     "type": "integer",
     "required": false
    },
    {
     "name": "reboot_policy",
     "type": "string: \"never\" \\| \"if_required\" \\| \"always\"",
     "required": false
    },
    {
     "name": "exclude_packages",
     "type": "array of any",
     "required": false
    },
    {
     "name": "pre_script_id",
     "type": "number",
     "required": false
    },
    {
     "name": "post_script_id",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#put-api-policies-id"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "DELETE",
   "path": "/api/policies/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/policies/:id",
   "summary": "Delete a patch policy",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#delete-api-policies-id"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/policies/:id/run",
   "url": "https://<your-org>.brambleit.cloud/warden/api/policies/:id/run",
   "summary": "Run a patch policy now",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#post-api-policies-id-run"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/removals",
   "url": "https://<your-org>.brambleit.cloud/warden/api/removals",
   "summary": "Plan removing a package",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "package",
     "type": "any",
     "required": false
    },
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "device_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#post-api-removals"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "GET",
   "path": "/api/removals",
   "url": "https://<your-org>.brambleit.cloud/warden/api/removals",
   "summary": "List package removals",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "ids",
    "device_id",
    "package"
   ],
   "body": [],
   "docs": "/developers/reference/warden/patching#get-api-removals"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/removals/:id/confirm",
   "url": "https://<your-org>.brambleit.cloud/warden/api/removals/:id/confirm",
   "summary": "Confirm a package removal",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "accept_extra",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#post-api-removals-id-confirm"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/removals/:id/cancel",
   "url": "https://<your-org>.brambleit.cloud/warden/api/removals/:id/cancel",
   "summary": "Cancel a package removal",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#post-api-removals-id-cancel"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/os-upgrades",
   "url": "https://<your-org>.brambleit.cloud/warden/api/os-upgrades",
   "summary": "Plan an OS release upgrade",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#post-api-os-upgrades"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "GET",
   "path": "/api/os-upgrades",
   "url": "https://<your-org>.brambleit.cloud/warden/api/os-upgrades",
   "summary": "List OS upgrades",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "ids",
    "device_id"
   ],
   "body": [],
   "docs": "/developers/reference/warden/patching#get-api-os-upgrades"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/os-upgrades/:id/confirm",
   "url": "https://<your-org>.brambleit.cloud/warden/api/os-upgrades/:id/confirm",
   "summary": "Confirm an OS upgrade",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "confirm_name",
     "type": "string",
     "required": false
    },
    {
     "name": "reboot",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/patching#post-api-os-upgrades-id-confirm"
  },
  {
   "section": "warden",
   "resource": "devices",
   "method": "POST",
   "path": "/api/devices/:id/reboot",
   "url": "https://<your-org>.brambleit.cloud/warden/api/devices/:id/reboot",
   "summary": "Reboot a device now (clears the \"reboot pending\" upgrade blocker)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/devices#post-api-devices-id-reboot"
  },
  {
   "section": "warden",
   "resource": "devices",
   "method": "POST",
   "path": "/api/devices/:id/exclude",
   "url": "https://<your-org>.brambleit.cloud/warden/api/devices/:id/exclude",
   "summary": "Exclude a device from Warden (\"don't check\"), or include it again",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "reason",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/devices#post-api-devices-id-exclude"
  },
  {
   "section": "warden",
   "resource": "devices",
   "method": "DELETE",
   "path": "/api/devices/:id/exclude",
   "url": "https://<your-org>.brambleit.cloud/warden/api/devices/:id/exclude",
   "summary": "Include an excluded device again",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/devices#delete-api-devices-id-exclude"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "GET",
   "path": "/api/os-upgrades/:id/output",
   "url": "https://<your-org>.brambleit.cloud/warden/api/os-upgrades/:id/output",
   "summary": "What the device printed, plus its release upgrade logs once fetched",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#get-api-os-upgrades-id-output"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/os-upgrades/:id/logs",
   "url": "https://<your-org>.brambleit.cloud/warden/api/os-upgrades/:id/logs",
   "summary": "Fetch an upgrade's logs from the device",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#post-api-os-upgrades-id-logs"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/os-upgrades/:id/cancel",
   "url": "https://<your-org>.brambleit.cloud/warden/api/os-upgrades/:id/cancel",
   "summary": "Cancel an OS upgrade",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#post-api-os-upgrades-id-cancel"
  },
  {
   "section": "warden",
   "resource": "tickets",
   "method": "GET",
   "path": "/api/tickets",
   "url": "https://<your-org>.brambleit.cloud/warden/api/tickets",
   "summary": "List Warden's PSA tickets",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/tickets#get-api-tickets"
  },
  {
   "section": "warden",
   "resource": "tickets",
   "method": "POST",
   "path": "/api/tickets",
   "url": "https://<your-org>.brambleit.cloud/warden/api/tickets",
   "summary": "Raise a PSA ticket for a finding",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "package",
     "type": "string",
     "required": false
    },
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/tickets#post-api-tickets"
  },
  {
   "section": "warden",
   "resource": "network",
   "method": "GET",
   "path": "/api/network",
   "url": "https://<your-org>.brambleit.cloud/warden/api/network",
   "summary": "Scoped by the probe that saw a host: with a site/group picked, only that site's probes, their hosts and findings",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/network#get-api-network"
  },
  {
   "section": "warden",
   "resource": "network",
   "method": "POST",
   "path": "/api/network/scan",
   "url": "https://<your-org>.brambleit.cloud/warden/api/network/scan",
   "summary": "Scan network hosts now",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/network#post-api-network-scan"
  },
  {
   "section": "warden",
   "resource": "network",
   "method": "POST",
   "path": "/api/network/findings/status",
   "url": "https://<your-org>.brambleit.cloud/warden/api/network/findings/status",
   "summary": "Accept or dismiss network findings",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/network#post-api-network-findings-status"
  },
  {
   "section": "warden",
   "resource": "agent-updates",
   "method": "GET",
   "path": "/api/agent-updates",
   "url": "https://<your-org>.brambleit.cloud/warden/api/agent-updates",
   "summary": "List agent updates",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/agent-updates#get-api-agent-updates"
  },
  {
   "section": "warden",
   "resource": "agent-updates",
   "method": "PUT",
   "path": "/api/agent-updates/policy",
   "url": "https://<your-org>.brambleit.cloud/warden/api/agent-updates/policy",
   "summary": "Set the agent update window",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "schedule_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "window_start",
     "type": "any",
     "required": false
    },
    {
     "name": "window_minutes",
     "type": "integer",
     "required": false
    },
    {
     "name": "timezone",
     "type": "any",
     "required": false
    },
    {
     "name": "max_parallel",
     "type": "integer",
     "required": false
    },
    {
     "name": "excluded_devices",
     "type": "array of any",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "update_rmm",
     "type": "any",
     "required": false
    },
    {
     "name": "update_remote",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/agent-updates#put-api-agent-updates-policy"
  },
  {
   "section": "warden",
   "resource": "agent-updates",
   "method": "POST",
   "path": "/api/agent-updates/run",
   "url": "https://<your-org>.brambleit.cloud/warden/api/agent-updates/run",
   "summary": "Update agents now",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "component",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/agent-updates#post-api-agent-updates-run"
  },
  {
   "section": "warden",
   "resource": "network",
   "method": "GET",
   "path": "/api/network/kit",
   "url": "https://<your-org>.brambleit.cloud/warden/api/network/kit",
   "summary": "Connectors are set up in BRM-Admin → Warden → Network integrations",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/network#get-api-network-kit"
  },
  {
   "section": "warden",
   "resource": "network",
   "method": "POST",
   "path": "/api/network/kit/:id/poll",
   "url": "https://<your-org>.brambleit.cloud/warden/api/network/kit/:id/poll",
   "summary": "Refresh a network device now",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/network#post-api-network-kit-id-poll"
  },
  {
   "section": "warden",
   "resource": "network",
   "method": "POST",
   "path": "/api/network/kit/upgrade",
   "url": "https://<your-org>.brambleit.cloud/warden/api/network/kit/upgrade",
   "summary": "Firmware upgrades: { connector_id, device_ids, when (ISO time, or empty for now) }",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "connector_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "when",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/network#post-api-network-kit-upgrade"
  },
  {
   "section": "warden",
   "resource": "network",
   "method": "DELETE",
   "path": "/api/network/kit/jobs/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/network/kit/jobs/:id",
   "summary": "Cancel a firmware upgrade",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/network#delete-api-network-kit-jobs-id"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "GET",
   "path": "/api/ce",
   "url": "https://<your-org>.brambleit.cloud/warden/api/ce",
   "summary": "Cyber Essentials status",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#get-api-ce"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "GET",
   "path": "/api/wu",
   "url": "https://<your-org>.brambleit.cloud/warden/api/wu",
   "summary": "Windows Update profiles",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#get-api-wu"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "POST",
   "path": "/api/wu/profiles",
   "url": "https://<your-org>.brambleit.cloud/warden/api/wu/profiles",
   "summary": "Create a Windows Update profile",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#post-api-wu-profiles"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "PUT",
   "path": "/api/wu/profiles/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/wu/profiles/:id",
   "summary": "Update a Windows Update profile",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#put-api-wu-profiles-id"
  },
  {
   "section": "warden",
   "resource": "patching",
   "method": "DELETE",
   "path": "/api/wu/profiles/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/wu/profiles/:id",
   "summary": "Delete a Windows Update profile",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/patching#delete-api-wu-profiles-id"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "GET",
   "path": "/api/remediation",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation",
   "summary": "List remediation plans",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#get-api-remediation"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "POST",
   "path": "/api/remediation",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation",
   "summary": "Plan Cyber Essentials fixes",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "controls",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/ce#post-api-remediation"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "GET",
   "path": "/api/remediation/items",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/items",
   "summary": "Outstanding items across open plans (optionally ?control=firewall)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "control"
   ],
   "body": [],
   "docs": "/developers/reference/warden/ce#get-api-remediation-items"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "GET",
   "path": "/api/remediation/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/:id",
   "summary": "Get a remediation plan",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#get-api-remediation-id"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "PATCH",
   "path": "/api/remediation/items/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/items/:id",
   "summary": "Change a plan item",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "selected",
     "type": "any",
     "required": false
    },
    {
     "name": "ports",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/ce#patch-api-remediation-items-id"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "POST",
   "path": "/api/remediation/:id/approve",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/:id/approve",
   "summary": "Approve and apply a plan",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#post-api-remediation-id-approve"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "POST",
   "path": "/api/remediation/:id/discard",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/:id/discard",
   "summary": "Discard a plan",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#post-api-remediation-id-discard"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "POST",
   "path": "/api/remediation/items/:id/undo",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/items/:id/undo",
   "summary": "Undo an applied fix",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#post-api-remediation-items-id-undo"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "POST",
   "path": "/api/remediation/items/:id/done",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/items/:id/done",
   "summary": "Mark a manual item done",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#post-api-remediation-items-id-done"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "POST",
   "path": "/api/remediation/items/:id/dismiss",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/items/:id/dismiss",
   "summary": "Dismiss an item",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#post-api-remediation-items-id-dismiss"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "POST",
   "path": "/api/remediation/:id/apply",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/:id/apply",
   "summary": "Apply more of an approved plan: unticked items, or retry failed ones",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "item_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/ce#post-api-remediation-id-apply"
  },
  {
   "section": "warden",
   "resource": "ce",
   "method": "POST",
   "path": "/api/remediation/:id/close",
   "url": "https://<your-org>.brambleit.cloud/warden/api/remediation/:id/close",
   "summary": "Close a plan",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/ce#post-api-remediation-id-close"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "GET",
   "path": "/api/alerts",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts",
   "summary": "Critical advisories, newly exploited CVEs and people's own alerts, with where each device in scope stands: affected / possibly / patched / safe",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/alerts#get-api-alerts"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "GET",
   "path": "/api/notices",
   "url": "https://<your-org>.brambleit.cloud/warden/api/notices",
   "summary": "Public notices (lib/notices.js): everything NCSC / CERT-EU published about vulnerabilities, with the alert each one raised or joined",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/alerts#get-api-notices"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "GET",
   "path": "/api/alerts/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts/:id",
   "summary": "Get an alert with affected devices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [
    "cves"
   ],
   "body": [],
   "docs": "/developers/reference/warden/alerts#get-api-alerts-id"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "POST",
   "path": "/api/alerts/lookup",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts/lookup",
   "summary": "Reads a pasted link (NCSC / vendor notice) for the \"Track an alert\" form: its title, summary, CVE IDs and the distro advisories that cover them",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "url",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/alerts#post-api-alerts-lookup"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "POST",
   "path": "/api/alerts",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts",
   "summary": "Add an alert by hand",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "force",
     "type": "any",
     "required": false
    },
    {
     "name": "title",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/alerts#post-api-alerts"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "PUT",
   "path": "/api/alerts/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts/:id",
   "summary": "Update an alert",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/alerts#put-api-alerts-id"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "DELETE",
   "path": "/api/alerts/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts/:id",
   "summary": "Delete an alert",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/alerts#delete-api-alerts-id"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "POST",
   "path": "/api/alerts/:id/dismiss",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts/:id/dismiss",
   "summary": "Archive or restore an alert",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "restore",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/alerts#post-api-alerts-id-dismiss"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "POST",
   "path": "/api/alerts/:id/recheck",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts/:id/recheck",
   "summary": "Check devices against an alert again",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/alerts#post-api-alerts-id-recheck"
  },
  {
   "section": "warden",
   "resource": "alerts",
   "method": "POST",
   "path": "/api/alerts/:id/containers/accept",
   "url": "https://<your-org>.brambleit.cloud/warden/api/alerts/:id/containers/accept",
   "summary": "A container image on one device: accept this alert's findings in it until a newer image is out ({ device_id, image_id, undo })",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "image_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "undo",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/alerts#post-api-alerts-id-containers-accept"
  },
  {
   "section": "warden",
   "resource": "containers",
   "method": "GET",
   "path": "/api/containers",
   "url": "https://<your-org>.brambleit.cloud/warden/api/containers",
   "summary": "Every Docker image on the devices in scope, its containers and findings, plus which Docker hosts don't report image packages yet (agent < 6.23.0)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/containers#get-api-containers"
  },
  {
   "section": "warden",
   "resource": "containers",
   "method": "POST",
   "path": "/api/containers/actions",
   "url": "https://<your-org>.brambleit.cloud/warden/api/containers/actions",
   "summary": "Start / stop / restart / update containers (lib/containeractions.js)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "action",
     "type": "string",
     "required": false
    },
    {
     "name": "targets",
     "type": "array of any",
     "required": false
    },
    {
     "name": "all",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/containers#post-api-containers-actions"
  },
  {
   "section": "warden",
   "resource": "containers",
   "method": "GET",
   "path": "/api/containers/actions/:id/output",
   "url": "https://<your-org>.brambleit.cloud/warden/api/containers/actions/:id/output",
   "summary": "Output of a container action",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/containers#get-api-containers-actions-id-output"
  },
  {
   "section": "warden",
   "resource": "containers",
   "method": "GET",
   "path": "/api/containers/:device/:image/findings",
   "url": "https://<your-org>.brambleit.cloud/warden/api/containers/:device/:image/findings",
   "summary": "A container image's vulnerabilities",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "device",
    "image"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/containers#get-api-containers-device-image-findings"
  },
  {
   "section": "warden",
   "resource": "overview",
   "method": "GET",
   "path": "/api/settings",
   "url": "https://<your-org>.brambleit.cloud/warden/api/settings",
   "summary": "Warden settings (read-only)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/overview#get-api-settings"
  },
  {
   "section": "warden",
   "resource": "overview",
   "method": "GET",
   "path": "/api/lookups",
   "url": "https://<your-org>.brambleit.cloud/warden/api/lookups",
   "summary": "Lists for filters (sites, groups, packages…)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/overview#get-api-lookups"
  },
  {
   "section": "warden",
   "resource": "overview",
   "method": "GET",
   "path": "/api/activity",
   "url": "https://<your-org>.brambleit.cloud/warden/api/activity",
   "summary": "Recent activity",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/overview#get-api-activity"
  },
  {
   "section": "warden",
   "resource": "siem",
   "method": "GET",
   "path": "/api/siem/status",
   "url": "https://<your-org>.brambleit.cloud/warden/api/siem/status",
   "summary": "SIEM collection status",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/siem#get-api-siem-status"
  },
  {
   "section": "warden",
   "resource": "siem",
   "method": "GET",
   "path": "/api/siem/summary",
   "url": "https://<your-org>.brambleit.cloud/warden/api/siem/summary",
   "summary": "SIEM summary",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/siem#get-api-siem-summary"
  },
  {
   "section": "warden",
   "resource": "siem",
   "method": "GET",
   "path": "/api/siem/events",
   "url": "https://<your-org>.brambleit.cloud/warden/api/siem/events",
   "summary": "Search security events",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "before",
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/warden/siem#get-api-siem-events"
  },
  {
   "section": "warden",
   "resource": "siem",
   "method": "GET",
   "path": "/api/siem/event",
   "url": "https://<your-org>.brambleit.cloud/warden/api/siem/event",
   "summary": "Get one security event",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "device_id",
    "ts",
    "channel",
    "record_id"
   ],
   "body": [],
   "docs": "/developers/reference/warden/siem#get-api-siem-event"
  },
  {
   "section": "warden",
   "resource": "siem",
   "method": "GET",
   "path": "/api/siem/devices",
   "url": "https://<your-org>.brambleit.cloud/warden/api/siem/devices",
   "summary": "Every device in scope, with collection status and the audit policy state",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/siem#get-api-siem-devices"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "GET",
   "path": "/api/baseline",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline",
   "summary": "Hardening overview",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#get-api-baseline"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/enable",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/enable",
   "summary": "Opt-in: Hardening checks run only for organisations that turned it on",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "on",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-enable"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "GET",
   "path": "/api/baseline/policy",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/policy",
   "summary": "The Hardening policy: which rules, per device type, and applying it to a domain as GPOs",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#get-api-baseline-policy"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "PUT",
   "path": "/api/baseline/policy",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/policy",
   "summary": "Update the hardening policy",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#put-api-baseline-policy"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/policy/apply",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/policy/apply",
   "summary": "Apply the hardening policy to a domain as Group Policy",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-policy-apply"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/policy/applies/:id/undo",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/policy/applies/:id/undo",
   "summary": "Undo a Group Policy apply",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-policy-applies-id-undo"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "GET",
   "path": "/api/baseline/platforms",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/platforms",
   "summary": "Hardening by platform",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#get-api-baseline-platforms"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "GET",
   "path": "/api/baseline/platforms/:os",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/platforms/:os",
   "summary": "One platform's rules and devices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "os"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#get-api-baseline-platforms-os"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "GET",
   "path": "/api/baseline/rules/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/rules/:id",
   "summary": "Get a hardening rule",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#get-api-baseline-rules-id"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/policy/rules",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/policy/rules",
   "summary": "Add rules to the policy, or take them out, for some device types",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "rule_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "profiles",
     "type": "array of any",
     "required": false
    },
    {
     "name": "on",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-policy-rules"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/policy/apply-now",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/policy/apply-now",
   "summary": "Apply the policy now on one platform's devices outside a domain (Warden fixes them itself)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "os",
     "type": "string: \"windows\" \\| \"linux\"",
     "required": false
    },
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "profile",
     "type": "string",
     "required": false
    },
    {
     "name": "rule_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-policy-apply-now"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "GET",
   "path": "/api/baseline/devices/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/devices/:id",
   "summary": "A device's hardening results",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#get-api-baseline-devices-id"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "PUT",
   "path": "/api/baseline/devices/:id/type",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/devices/:id/type",
   "summary": "A Linux device's type (server / workstation) by hand, or null for detected",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "profile",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#put-api-baseline-devices-id-type"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/check",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/check",
   "summary": "Check devices against the baseline now",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-check"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/plan",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/plan",
   "summary": "Plan hardening fixes",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "rule_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-plan"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/apply",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/apply",
   "summary": "Apply planned hardening fixes",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "items",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-apply"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "POST",
   "path": "/api/baseline/undo",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/undo",
   "summary": "Undo hardening fixes on a device",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "rule_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#post-api-baseline-undo"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "GET",
   "path": "/api/baseline/standard",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/standard",
   "summary": "The Hardening policy as a script a domain admin can run instead of Apply",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/warden/baseline#get-api-baseline-standard"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "GET",
   "path": "/api/baseline/local-standard",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/local-standard",
   "summary": "The standard on Windows devices outside a domain (applied by Warden)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/baseline#get-api-baseline-local-standard"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "PUT",
   "path": "/api/baseline/local-standard",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/local-standard",
   "summary": "Set the standard for devices outside a domain",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "os",
     "type": "any",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "scope_type",
     "type": "string: \"all\" \\| \"site\" \\| \"group\" \\| \"device\"",
     "required": false
    },
    {
     "name": "scope_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "platforms",
     "type": "array of any",
     "required": false
    },
    {
     "name": "include_strict",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#put-api-baseline-local-standard"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "PUT",
   "path": "/api/baseline/exceptions",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/exceptions",
   "summary": "Add a hardening exception",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "string",
     "required": false
    },
    {
     "name": "rule_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "reason",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#put-api-baseline-exceptions"
  },
  {
   "section": "warden",
   "resource": "baseline",
   "method": "DELETE",
   "path": "/api/baseline/exceptions",
   "url": "https://<your-org>.brambleit.cloud/warden/api/baseline/exceptions",
   "summary": "Remove a hardening exception",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "rule_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "device_id",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/baseline#delete-api-baseline-exceptions"
  },
  {
   "section": "warden",
   "resource": "gpo",
   "method": "GET",
   "path": "/api/gpo",
   "url": "https://<your-org>.brambleit.cloud/warden/api/gpo",
   "summary": "Domains and Group Policy objects",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/gpo#get-api-gpo"
  },
  {
   "section": "warden",
   "resource": "gpo",
   "method": "POST",
   "path": "/api/gpo/changes",
   "url": "https://<your-org>.brambleit.cloud/warden/api/gpo/changes",
   "summary": "Changes in Active Directory / Group Policy (warden.directory.manage)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "action",
     "type": "any",
     "required": false
    },
    {
     "name": "params",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/gpo#post-api-gpo-changes"
  },
  {
   "section": "warden",
   "resource": "gpo",
   "method": "POST",
   "path": "/api/gpo/changes/:id/undo",
   "url": "https://<your-org>.brambleit.cloud/warden/api/gpo/changes/:id/undo",
   "summary": "Undo a directory change",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden.",
    "Permission (any of): `warden.directory.manage`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/gpo#post-api-gpo-changes-id-undo"
  },
  {
   "section": "warden",
   "resource": "gpo",
   "method": "POST",
   "path": "/api/gpo/refresh",
   "url": "https://<your-org>.brambleit.cloud/warden/api/gpo/refresh",
   "summary": "Read Group Policy from the domain again",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/gpo#post-api-gpo-refresh"
  },
  {
   "section": "warden",
   "resource": "gpo",
   "method": "POST",
   "path": "/api/gpo/requirements",
   "url": "https://<your-org>.brambleit.cloud/warden/api/gpo/requirements",
   "summary": "Require a GPO on devices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "gpo_guid",
     "type": "any",
     "required": false
    },
    {
     "name": "targets",
     "type": "array of any",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/gpo#post-api-gpo-requirements"
  },
  {
   "section": "warden",
   "resource": "gpo",
   "method": "DELETE",
   "path": "/api/gpo/requirements/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/gpo/requirements/:id",
   "summary": "Remove a GPO requirement",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/gpo#delete-api-gpo-requirements-id"
  },
  {
   "section": "warden",
   "resource": "gpo",
   "method": "POST",
   "path": "/api/gpo/gpupdate",
   "url": "https://<your-org>.brambleit.cloud/warden/api/gpo/gpupdate",
   "summary": "Run gpupdate on devices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/warden/gpo#post-api-gpo-gpupdate"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "GET",
   "path": "/api/audits",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits",
   "summary": "List security audits",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#get-api-audits"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "POST",
   "path": "/api/audits",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits",
   "summary": "Start a security audit",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#post-api-audits"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "GET",
   "path": "/api/audits/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits/:id",
   "summary": "Get an audit with its questions and answers",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#get-api-audits-id"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "PUT",
   "path": "/api/audits/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits/:id",
   "summary": "Update an audit",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#put-api-audits-id"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "PUT",
   "path": "/api/audits/:id/answers/:qid",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits/:id/answers/:qid",
   "summary": "Answer a question",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id",
    "qid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#put-api-audits-id-answers-qid"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "POST",
   "path": "/api/audits/:id/refresh",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits/:id/refresh",
   "summary": "Fill in answers from device data again",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#post-api-audits-id-refresh"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "POST",
   "path": "/api/audits/:id/complete",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits/:id/complete",
   "summary": "Complete an audit",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#post-api-audits-id-complete"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "POST",
   "path": "/api/audits/:id/reopen",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits/:id/reopen",
   "summary": "Reopen an audit",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#post-api-audits-id-reopen"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "DELETE",
   "path": "/api/audits/:id",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits/:id",
   "summary": "Delete an audit",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#delete-api-audits-id"
  },
  {
   "section": "warden",
   "resource": "audits",
   "method": "GET",
   "path": "/api/audits/:id/report",
   "url": "https://<your-org>.brambleit.cloud/warden/api/audits/:id/report",
   "summary": "The customer report: a printable HTML page (Print → Save as PDF)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Warden."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/warden/audits#get-api-audits-id-report"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "GET",
   "path": "/v1/app/psa/check",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/check",
   "summary": "Check PSA app access",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/tickets#get-v1-app-psa-check"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "GET",
   "path": "/v1/app/psa/agents",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/agents",
   "summary": "List agents (tenant users)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/queues#get-v1-app-psa-agents"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "GET",
   "path": "/v1/app/psa/queues",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/queues",
   "summary": "List queues for tenant (inc",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/queues#get-v1-app-psa-queues"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "POST",
   "path": "/v1/app/psa/queues",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/queues",
   "summary": "Create a queue (set parent_id for sub-queue)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "email_address",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_host",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_port",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_user",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_pass",
     "type": "array of any",
     "required": false
    },
    {
     "name": "imap_tls",
     "type": "array of any",
     "required": false
    },
    {
     "name": "smtp_host",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_port",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_user",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_pass",
     "type": "array of any",
     "required": false
    },
    {
     "name": "smtp_from",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/queues#post-v1-app-psa-queues"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "POST",
   "path": "/v1/app/psa/queues/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/queues/:id",
   "summary": "Update a queue",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "string",
     "required": false
    },
    {
     "name": "email_address",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_host",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_port",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_user",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_pass",
     "type": "array of any",
     "required": false
    },
    {
     "name": "imap_tls",
     "type": "array of any",
     "required": false
    },
    {
     "name": "smtp_host",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_port",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_user",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_pass",
     "type": "array of any",
     "required": false
    },
    {
     "name": "smtp_from",
     "type": "any",
     "required": false
    },
    {
     "name": "is_active",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/queues#post-v1-app-psa-queues-id"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "POST",
   "path": "/v1/app/psa/queues/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/queues/:id/delete",
   "summary": "Delete a queue (also removes sub-queues via FK cascade)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/queues#post-v1-app-psa-queues-id-delete"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "POST",
   "path": "/v1/app/psa/queues/:id/test-imap",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/queues/:id/test-imap",
   "summary": "Test IMAP connection for a specific queue",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/queues#post-v1-app-psa-queues-id-test-imap"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/app/psa/customers",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers",
   "summary": "List customers",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#get-v1-app-psa-customers"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "POST",
   "path": "/v1/app/psa/customers",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers",
   "summary": "Create customer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "any",
     "required": false
    },
    {
     "name": "address",
     "type": "any",
     "required": false
    },
    {
     "name": "notes",
     "type": "array of any",
     "required": false
    },
    {
     "name": "account_manager_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/customers#post-v1-app-psa-customers"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "POST",
   "path": "/v1/app/psa/customers/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id",
   "summary": "Update customer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "any",
     "required": false
    },
    {
     "name": "address",
     "type": "any",
     "required": false
    },
    {
     "name": "notes",
     "type": "array of any",
     "required": false
    },
    {
     "name": "account_manager_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/customers#post-v1-app-psa-customers-id"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "POST",
   "path": "/v1/app/psa/customers/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/delete",
   "summary": "Delete customer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#post-v1-app-psa-customers-id-delete"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/app/psa/customers/:id/contacts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/contacts",
   "summary": "Contacts for a customer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#get-v1-app-psa-customers-id-contacts"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/app/psa/customers/:id/tickets",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/tickets",
   "summary": "Tickets for a customer",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#get-v1-app-psa-customers-id-tickets"
  },
  {
   "section": "psa",
   "resource": "contacts",
   "method": "GET",
   "path": "/v1/app/psa/contacts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/contacts",
   "summary": "List contacts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/contacts#get-v1-app-psa-contacts"
  },
  {
   "section": "psa",
   "resource": "contacts",
   "method": "POST",
   "path": "/v1/app/psa/contacts",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/contacts",
   "summary": "Create contact",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "first_name",
     "type": "string",
     "required": true
    },
    {
     "name": "last_name",
     "type": "string",
     "required": true
    },
    {
     "name": "email",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "any",
     "required": false
    },
    {
     "name": "job_title",
     "type": "string",
     "required": false
    },
    {
     "name": "notes",
     "type": "array of any",
     "required": false
    },
    {
     "name": "customer_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/contacts#post-v1-app-psa-contacts"
  },
  {
   "section": "psa",
   "resource": "contacts",
   "method": "POST",
   "path": "/v1/app/psa/contacts/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/contacts/:id",
   "summary": "Update contact",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "first_name",
     "type": "string",
     "required": false
    },
    {
     "name": "last_name",
     "type": "string",
     "required": false
    },
    {
     "name": "email",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "any",
     "required": false
    },
    {
     "name": "job_title",
     "type": "string",
     "required": false
    },
    {
     "name": "notes",
     "type": "array of any",
     "required": false
    },
    {
     "name": "customer_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/contacts#post-v1-app-psa-contacts-id"
  },
  {
   "section": "psa",
   "resource": "contacts",
   "method": "POST",
   "path": "/v1/app/psa/contacts/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/contacts/:id/delete",
   "summary": "Delete contact",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/contacts#post-v1-app-psa-contacts-id-delete"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "GET",
   "path": "/v1/app/psa/tickets",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/tickets",
   "summary": "List tickets for tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [
    "view",
    "q",
    "queue_id",
    "customer_id",
    "priority",
    "type_id",
    "category_id",
    "status_id",
    "limit",
    "offset"
   ],
   "body": [],
   "docs": "/developers/reference/psa/tickets#get-v1-app-psa-tickets"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "GET",
   "path": "/v1/app/psa/tickets/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/tickets/:id",
   "summary": "Get a single ticket with messages and activity",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/tickets#get-v1-app-psa-tickets-id"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "POST",
   "path": "/v1/app/psa/tickets",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/tickets",
   "summary": "Create a ticket",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "type_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "category_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "subcategory_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "subject",
     "type": "any",
     "required": true
    },
    {
     "name": "queue_id",
     "type": "number",
     "required": true
    },
    {
     "name": "customer_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "contact_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "priority",
     "type": "any",
     "required": false
    },
    {
     "name": "assigned_to",
     "type": "any",
     "required": false
    },
    {
     "name": "body_html",
     "type": "any",
     "required": false
    },
    {
     "name": "body",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/tickets#post-v1-app-psa-tickets"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "POST",
   "path": "/v1/app/psa/tickets/bulk",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/tickets/bulk",
   "summary": "Bulk update tickets (close, set_status, set_type, set_category, set_priority, assign)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "action",
     "type": "string",
     "required": true
    },
    {
     "name": "ticket_ids",
     "type": "array of any",
     "required": true
    },
    {
     "name": "value",
     "type": "number: \"low\" \\| \"medium\" \\| \"high\" \\| \"critical\"",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/tickets#post-v1-app-psa-tickets-bulk"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "POST",
   "path": "/v1/app/psa/tickets/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/tickets/:id",
   "summary": "Update ticket fields",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "type_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "category_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "subcategory_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "status_id",
     "type": "number",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "queue_id",
     "type": "number",
     "required": false
    },
    {
     "name": "subject",
     "type": "any",
     "required": true
    },
    {
     "name": "reply_to_email",
     "type": "string",
     "required": false
    },
    {
     "name": "cc_emails",
     "type": "string (email)",
     "required": false
    },
    {
     "name": "assigned_to",
     "type": "number",
     "required": false
    },
    {
     "name": "key",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/tickets#post-v1-app-psa-tickets-id"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "POST",
   "path": "/v1/app/psa/tickets/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/tickets/:id/delete",
   "summary": "Delete ticket",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/tickets#post-v1-app-psa-tickets-id-delete"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "POST",
   "path": "/v1/app/psa/tickets/:id/messages",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/tickets/:id/messages",
   "summary": "Add a message or internal note to a ticket",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "body_html",
     "type": "any",
     "required": false
    },
    {
     "name": "body",
     "type": "any",
     "required": false
    },
    {
     "name": "attachments",
     "type": "array of any",
     "required": false
    },
    {
     "name": "status_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "to",
     "type": "string (email)",
     "required": false
    },
    {
     "name": "cc",
     "type": "string (email)",
     "required": false
    },
    {
     "name": "is_resolution",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/tickets#post-v1-app-psa-tickets-id-messages"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "GET",
   "path": "/v1/app/psa/statuses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/statuses",
   "summary": "List email templates",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/queues#get-v1-app-psa-statuses"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "GET",
   "path": "/v1/app/psa/types",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/types",
   "summary": "List ticket types",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/queues#get-v1-app-psa-types"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "GET",
   "path": "/v1/app/psa/me/signature",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/me/signature",
   "summary": "Your own email signature (PSA v2, ticket #57): added under every reply you send",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/config#get-v1-app-psa-me-signature"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "PUT",
   "path": "/v1/app/psa/me/signature",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/me/signature",
   "summary": "Set your email signature",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "signature_html",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/config#put-v1-app-psa-me-signature"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "GET",
   "path": "/v1/app/psa/templates",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/templates",
   "summary": "List reply templates",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/queues#get-v1-app-psa-templates"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "GET",
   "path": "/v1/app/psa/config",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/config",
   "summary": "Get tenant PSA config",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/config#get-v1-app-psa-config"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "POST",
   "path": "/v1/app/psa/config",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/config",
   "summary": "Save tenant PSA config (upsert)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "smtp_host",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_port",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_user",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_pass",
     "type": "array of any",
     "required": false
    },
    {
     "name": "smtp_from",
     "type": "any",
     "required": false
    },
    {
     "name": "smtp_from_name",
     "type": "string",
     "required": false
    },
    {
     "name": "imap_host",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_port",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_user",
     "type": "any",
     "required": false
    },
    {
     "name": "imap_pass",
     "type": "array of any",
     "required": false
    },
    {
     "name": "imap_tls",
     "type": "array of any",
     "required": false
    },
    {
     "name": "default_queue_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "ticket_prefix",
     "type": "any",
     "required": false
    },
    {
     "name": "brand_logo_url",
     "type": "string",
     "required": false
    },
    {
     "name": "brand_color",
     "type": "any",
     "required": false
    },
    {
     "name": "brand_footer",
     "type": "any",
     "required": false
    },
    {
     "name": "brand_footer_html",
     "type": "any",
     "required": false
    },
    {
     "name": "brand_signature_html",
     "type": "any",
     "required": false
    },
    {
     "name": "quote_previous",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/config#post-v1-app-psa-config"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "POST",
   "path": "/v1/app/psa/config/test-smtp",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/config/test-smtp",
   "summary": "Send a test email via configured SMTP",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "to",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/config#post-v1-app-psa-config-test-smtp"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "POST",
   "path": "/v1/app/psa/config/email-preview",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/config/email-preview",
   "summary": "Email preview for BRM-Admin → PSA → Branding: the saved settings with any unsaved changes from the form on top (nothing is stored)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "use_org",
     "type": "any",
     "required": false
    },
    {
     "name": "quote_previous",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/config#post-v1-app-psa-config-email-preview"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "GET",
   "path": "/v1/app/psa/attachments/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/attachments/:id",
   "summary": "Download/view an attachment by DB id",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/tickets#get-v1-app-psa-attachments-id"
  },
  {
   "section": "psa",
   "resource": "tickets",
   "method": "GET",
   "path": "/v1/app/psa/tickets/:id/attachments",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/tickets/:id/attachments",
   "summary": "List attachments for a ticket",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/tickets#get-v1-app-psa-tickets-id-attachments"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "GET",
   "path": "/v1/app/psa/config/poller-status",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/config/poller-status",
   "summary": "Get IMAP poller status (interval, last run, results)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/config#get-v1-app-psa-config-poller-status"
  },
  {
   "section": "psa",
   "resource": "categories",
   "method": "GET",
   "path": "/v1/app/psa/categories",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/categories",
   "summary": "List categories (flat, with parent_id)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [
    "queue_id"
   ],
   "body": [],
   "docs": "/developers/reference/psa/categories#get-v1-app-psa-categories"
  },
  {
   "section": "psa",
   "resource": "categories",
   "method": "POST",
   "path": "/v1/app/psa/categories",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/categories",
   "summary": "Create category",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/categories#post-v1-app-psa-categories"
  },
  {
   "section": "psa",
   "resource": "categories",
   "method": "POST",
   "path": "/v1/app/psa/categories/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/categories/:id",
   "summary": "Update category",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/categories#post-v1-app-psa-categories-id"
  },
  {
   "section": "psa",
   "resource": "categories",
   "method": "POST",
   "path": "/v1/app/psa/categories/:id/delete",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/categories/:id/delete",
   "summary": "Delete category",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/categories#post-v1-app-psa-categories-id-delete"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "GET",
   "path": "/v1/app/psa/queues/:id/categories",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/queues/:id/categories",
   "summary": "Get category IDs assigned to a queue",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/queues#get-v1-app-psa-queues-id-categories"
  },
  {
   "section": "psa",
   "resource": "queues",
   "method": "POST",
   "path": "/v1/app/psa/queues/:id/categories",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/queues/:id/categories",
   "summary": "Set categories for a queue (replaces all)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "category_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/queues#post-v1-app-psa-queues-id-categories"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "POST",
   "path": "/v1/app/psa/config/poll-now",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/config/poll-now",
   "summary": "Trigger an immediate IMAP poll",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/config#post-v1-app-psa-config-poll-now"
  },
  {
   "section": "psa",
   "resource": "config",
   "method": "POST",
   "path": "/v1/app/psa/config/test-imap",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/config/test-imap",
   "summary": "Test global IMAP connection",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/config#post-v1-app-psa-config-test-imap"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/app/psa/customers/:id/devices",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/devices",
   "summary": "════════════════════════════════════════════════════════════════════════════════ CUSTOMER ↔ RMM DEVICES  (RMM-license gated) ════════════════════════════════…",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA.",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#get-v1-app-psa-customers-id-devices"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/app/psa/rmm-sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/rmm-sites",
   "summary": "RMM sites (to link to customers)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA.",
    "Licence: RMM."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#get-v1-app-psa-rmm-sites"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "POST",
   "path": "/v1/app/psa/customers/:id/link-site",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/link-site",
   "summary": "Link a customer to an RMM site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA.",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "site_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/psa/customers#post-v1-app-psa-customers-id-link-site"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/app/psa/customers/:id/links",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/links",
   "summary": "One customer record (ticket #85, services/customerLinks.js): the RMM sites and the customer's own Bramble organisation linked to a PSA customer, plus what co…",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#get-v1-app-psa-customers-id-links"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/app/psa/customers/:id/agreement",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/agreement",
   "summary": "A customer's agreement",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#get-v1-app-psa-customers-id-agreement"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "POST",
   "path": "/v1/app/psa/customers/:id/agreement",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/agreement",
   "summary": "Add an agreement line",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#post-v1-app-psa-customers-id-agreement"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "PUT",
   "path": "/v1/app/psa/customers/:id/agreement/:lineId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/agreement/:lineId",
   "summary": "Update an agreement line",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id",
    "lineId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#put-v1-app-psa-customers-id-agreement-lineid"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "DELETE",
   "path": "/v1/app/psa/customers/:id/agreement/:lineId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/agreement/:lineId",
   "summary": "Remove an agreement line",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id",
    "lineId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/psa/customers#delete-v1-app-psa-customers-id-agreement-lineid"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "PUT",
   "path": "/v1/app/psa/customers/:id/bramble-tenant",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/bramble-tenant",
   "summary": "Link a customer to its Bramble organisation",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "tenant_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/psa/customers#put-v1-app-psa-customers-id-bramble-tenant"
  },
  {
   "section": "psa",
   "resource": "customers",
   "method": "POST",
   "path": "/v1/app/psa/customers/:id/unlink-site",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/psa/customers/:id/unlink-site",
   "summary": "Unlink a customer from an RMM site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: PSA.",
    "Licence: RMM."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "site_id",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/psa/customers#post-v1-app-psa-customers-id-unlink-site"
  },
  {
   "section": "projects",
   "resource": "admin",
   "method": "GET",
   "path": "/v1/app/project/images/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/images/:id",
   "summary": "Fetch a project image (icon/banner/comment attachment) by id",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/admin#get-v1-app-project-images-id"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "GET",
   "path": "/v1/app/project/projects",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects",
   "summary": "List projects the caller is a member of",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/projects#get-v1-app-project-projects"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "POST",
   "path": "/v1/app/project/projects",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects",
   "summary": "Create a project. Creator becomes owner; seeds the project with default work-package types and statuses",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/projects/projects#post-v1-app-project-projects"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "GET",
   "path": "/v1/app/project/projects/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id",
   "summary": "Get a single project",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/projects#get-v1-app-project-projects-id"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id",
   "summary": "Update a project's name/description/color/status/client",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    },
    {
     "name": "status",
     "type": "string: \"active\" \\| \"archived\"",
     "required": false
    },
    {
     "name": "client_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/projects#patch-v1-app-project-projects-id"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id",
   "summary": "Delete a project. Requires owner role on the project",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/projects#delete-v1-app-project-projects-id"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "GET",
   "path": "/v1/app/project/my-work",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/my-work",
   "summary": "List work packages assigned to the caller across every project in their tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [],
   "query": [
    "include_closed"
   ],
   "body": [],
   "docs": "/developers/reference/projects/projects#get-v1-app-project-my-work"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "GET",
   "path": "/v1/app/project/search",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/search",
   "summary": "Search work packages by subject across every project the caller belongs to",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/projects/projects#get-v1-app-project-search"
  },
  {
   "section": "projects",
   "resource": "notifications",
   "method": "GET",
   "path": "/v1/app/project/notifications",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/notifications",
   "summary": "List the caller's cross-project notifications",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [],
   "query": [
    "unread_only",
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/projects/notifications#get-v1-app-project-notifications"
  },
  {
   "section": "projects",
   "resource": "notifications",
   "method": "GET",
   "path": "/v1/app/project/notifications/unread-count",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/notifications/unread-count",
   "summary": "Get the caller's unread notification count",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/notifications#get-v1-app-project-notifications-unread-count"
  },
  {
   "section": "projects",
   "resource": "notifications",
   "method": "PATCH",
   "path": "/v1/app/project/notifications/:id/read",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/notifications/:id/read",
   "summary": "Mark a notification as read",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/notifications#patch-v1-app-project-notifications-id-read"
  },
  {
   "section": "projects",
   "resource": "notifications",
   "method": "POST",
   "path": "/v1/app/project/notifications/read-all",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/notifications/read-all",
   "summary": "Mark all of the caller's notifications as read",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/notifications#post-v1-app-project-notifications-read-all"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/icon",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/icon",
   "summary": "Upload a project's icon image",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/projects#post-v1-app-project-projects-id-icon"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/icon",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/icon",
   "summary": "Clear a project's icon image",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/projects#delete-v1-app-project-projects-id-icon"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/banner",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/banner",
   "summary": "Upload a project's banner image",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/projects#post-v1-app-project-projects-id-banner"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/banner",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/banner",
   "summary": "Clear a project's banner image",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/projects#delete-v1-app-project-projects-id-banner"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/members",
   "summary": "List a project's members",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/members#get-v1-app-project-projects-id-members"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/available-users",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/available-users",
   "summary": "List tenant users not yet on this project",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/members#get-v1-app-project-projects-id-available-users"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/members/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/members/:userId",
   "summary": "Change a project member's role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "userId"
   ],
   "query": [],
   "body": [
    {
     "name": "role",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/members#patch-v1-app-project-projects-id-members-userid"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/members/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/members/:userId",
   "summary": "Remove a project member, or leave the project yourself",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "userId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/members#delete-v1-app-project-projects-id-members-userid"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/invites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/invites",
   "summary": "List a project's pending invites",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/members#get-v1-app-project-projects-id-invites"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/invites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/invites",
   "summary": "Invite an existing tenant user to a project",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "role",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/members#post-v1-app-project-projects-id-invites"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/invites/:inviteId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/invites/:inviteId",
   "summary": "Revoke a pending project invite",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "inviteId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/members#delete-v1-app-project-projects-id-invites-inviteid"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "GET",
   "path": "/v1/app/project/invites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/invites",
   "summary": "List pending invites addressed to the caller",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/members#get-v1-app-project-invites"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "POST",
   "path": "/v1/app/project/invites/:id/accept",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/invites/:id/accept",
   "summary": "Accept a pending project invite",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/members#post-v1-app-project-invites-id-accept"
  },
  {
   "section": "projects",
   "resource": "members",
   "method": "POST",
   "path": "/v1/app/project/invites/:id/decline",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/invites/:id/decline",
   "summary": "Decline a pending project invite",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/members#post-v1-app-project-invites-id-decline"
  },
  {
   "section": "projects",
   "resource": "categories",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/categories",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/categories",
   "summary": "List a project's work-package categories",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/categories#get-v1-app-project-projects-id-categories"
  },
  {
   "section": "projects",
   "resource": "categories",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/categories",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/categories",
   "summary": "Create a work-package category",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/projects/categories#post-v1-app-project-projects-id-categories"
  },
  {
   "section": "projects",
   "resource": "categories",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/categories/:catId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/categories/:catId",
   "summary": "Update a work-package category",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "catId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/projects/categories#patch-v1-app-project-projects-id-categories-catid"
  },
  {
   "section": "projects",
   "resource": "categories",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/categories/:catId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/categories/:catId",
   "summary": "Delete a work-package category",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "catId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/categories#delete-v1-app-project-projects-id-categories-catid"
  },
  {
   "section": "projects",
   "resource": "types",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/types",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/types",
   "summary": "List a project's work-package types",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/types#get-v1-app-project-projects-id-types"
  },
  {
   "section": "projects",
   "resource": "types",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/types",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/types",
   "summary": "Create a work-package type",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    },
    {
     "name": "is_milestone",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/types#post-v1-app-project-projects-id-types"
  },
  {
   "section": "projects",
   "resource": "types",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/types/:typeId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/types/:typeId",
   "summary": "Update a work-package type",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "typeId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    },
    {
     "name": "is_milestone",
     "type": "boolean",
     "required": false
    },
    {
     "name": "position",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/types#patch-v1-app-project-projects-id-types-typeid"
  },
  {
   "section": "projects",
   "resource": "types",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/types/:typeId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/types/:typeId",
   "summary": "Delete a work-package type",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "typeId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/types#delete-v1-app-project-projects-id-types-typeid"
  },
  {
   "section": "projects",
   "resource": "statuses",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/statuses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/statuses",
   "summary": "List a project's statuses (also used as the Board's columns)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/statuses#get-v1-app-project-projects-id-statuses"
  },
  {
   "section": "projects",
   "resource": "statuses",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/statuses",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/statuses",
   "summary": "Create a status/board column",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    },
    {
     "name": "is_closed",
     "type": "boolean",
     "required": false
    },
    {
     "name": "is_default",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/statuses#post-v1-app-project-projects-id-statuses"
  },
  {
   "section": "projects",
   "resource": "statuses",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/statuses/:statusId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/statuses/:statusId",
   "summary": "Update a status/board column",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "statusId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    },
    {
     "name": "position",
     "type": "integer",
     "required": false
    },
    {
     "name": "is_closed",
     "type": "boolean",
     "required": false
    },
    {
     "name": "is_default",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/statuses#patch-v1-app-project-projects-id-statuses-statusid"
  },
  {
   "section": "projects",
   "resource": "statuses",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/statuses/:statusId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/statuses/:statusId",
   "summary": "Delete a status/board column",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "statusId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/statuses#delete-v1-app-project-projects-id-statuses-statusid"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/versions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/versions",
   "summary": "List a project's versions (Roadmap)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#get-v1-app-project-projects-id-versions"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/versions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/versions",
   "summary": "Create a version/roadmap milestone",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "start_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "due_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/work-packages#post-v1-app-project-projects-id-versions"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/versions/:versionId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/versions/:versionId",
   "summary": "Update a version/roadmap milestone",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "versionId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "start_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "due_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "position",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/work-packages#patch-v1-app-project-projects-id-versions-versionid"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/versions/:versionId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/versions/:versionId",
   "summary": "Delete a version/roadmap milestone",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "versionId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#delete-v1-app-project-projects-id-versions-versionid"
  },
  {
   "section": "projects",
   "resource": "categories",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/tags",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/tags",
   "summary": "List a project's tags",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/categories#get-v1-app-project-projects-id-tags"
  },
  {
   "section": "projects",
   "resource": "categories",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/tags",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/tags",
   "summary": "Create a work-package tag",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/projects/categories#post-v1-app-project-projects-id-tags"
  },
  {
   "section": "projects",
   "resource": "categories",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/tags/:tagId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/tags/:tagId",
   "summary": "Rename or recolor a tag",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "tagId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/projects/categories#patch-v1-app-project-projects-id-tags-tagid"
  },
  {
   "section": "projects",
   "resource": "categories",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/tags/:tagId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/tags/:tagId",
   "summary": "Delete a tag. Requires at least member role on the project",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "tagId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/categories#delete-v1-app-project-projects-id-tags-tagid"
  },
  {
   "section": "projects",
   "resource": "automation-rules",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/automation-rules",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/automation-rules",
   "summary": "A project's automation rules",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/automation-rules#get-v1-app-project-projects-id-automation-rules"
  },
  {
   "section": "projects",
   "resource": "automation-rules",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/automation-rules",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/automation-rules",
   "summary": "Admin role: higher than Tags'/ Categories' \"member\" tier, since a rule can auto-assign users or change status on every new work package, same tier as project…",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "conditions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/automation-rules#post-v1-app-project-projects-id-automation-rules"
  },
  {
   "section": "projects",
   "resource": "automation-rules",
   "method": "PUT",
   "path": "/v1/app/project/projects/:id/automation-rules/:ruleId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/automation-rules/:ruleId",
   "summary": "Bulk-replace name/conditions/ actions in one UPDATE (no transaction needed — see the JSON-column rationale above)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "ruleId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "conditions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "actions",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/automation-rules#put-v1-app-project-projects-id-automation-rules-ruleid"
  },
  {
   "section": "projects",
   "resource": "automation-rules",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/automation-rules/:ruleId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/automation-rules/:ruleId",
   "summary": "Just the enable/disable toggle, kept separate from PUT so the list view's switch doesn't have to resend the whole conditions/actions payload",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "ruleId"
   ],
   "query": [],
   "body": [
    {
     "name": "enabled",
     "type": "boolean",
     "required": true
    }
   ],
   "docs": "/developers/reference/projects/automation-rules#patch-v1-app-project-projects-id-automation-rules-ruleid"
  },
  {
   "section": "projects",
   "resource": "automation-rules",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/automation-rules/:ruleId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/automation-rules/:ruleId",
   "summary": "Delete an automation rule",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "ruleId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/automation-rules#delete-v1-app-project-projects-id-automation-rules-ruleid"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/work-packages",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages",
   "summary": "List a project's work packages",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [
    "status_id",
    "category_id",
    "type_id",
    "version_id",
    "priority",
    "assignee",
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#get-v1-app-project-projects-id-work-packages"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/work-packages",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages",
   "summary": "Create a work package",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "subject",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "type_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "status_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "version_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "category_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "priority",
     "type": "any",
     "required": false
    },
    {
     "name": "start_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "due_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "percent_done",
     "type": "number",
     "required": false
    },
    {
     "name": "assignee_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "tag_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/work-packages#post-v1-app-project-projects-id-work-packages"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId",
   "summary": "Get a single work package",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#get-v1-app-project-projects-id-work-packages-wpid"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId",
   "summary": "Update a work package",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId"
   ],
   "query": [],
   "body": [
    {
     "name": "subject",
     "type": "any",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "type_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "status_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "category_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "version_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "priority",
     "type": "any",
     "required": false
    },
    {
     "name": "start_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "due_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "percent_done",
     "type": "number",
     "required": false
    },
    {
     "name": "assignee_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "tag_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "completed",
     "type": "any",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/work-packages#patch-v1-app-project-projects-id-work-packages-wpid"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId/move",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId/move",
   "summary": "Move a work package between statuses/positions (Board drag-drop / reorder)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId"
   ],
   "query": [],
   "body": [
    {
     "name": "status_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "position",
     "type": "integer",
     "required": true
    },
    {
     "name": "order",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/work-packages#patch-v1-app-project-projects-id-work-packages-wpid-move"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId",
   "summary": "Delete a work package (soft delete)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#delete-v1-app-project-projects-id-work-packages-wpid"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/relations",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/relations",
   "summary": "List every work-package relation edge in the project",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#get-v1-app-project-projects-id-relations"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId/relations",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId/relations",
   "summary": "List a single work package's relations",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#get-v1-app-project-projects-id-work-packages-wpid-relations"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId/relations",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId/relations",
   "summary": "Create a relation between two work packages",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId"
   ],
   "query": [],
   "body": [
    {
     "name": "related_id",
     "type": "string",
     "required": true
    },
    {
     "name": "relation_type",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/work-packages#post-v1-app-project-projects-id-work-packages-wpid-relations"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId/relations/:relId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId/relations/:relId",
   "summary": "Delete a work-package relation",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId",
    "relId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#delete-v1-app-project-projects-id-work-packages-wpid-relations-relid"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId/comments",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId/comments",
   "summary": "List a work package's comments",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#get-v1-app-project-projects-id-work-packages-wpid-comments"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId/comments",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId/comments",
   "summary": "Add a comment to a work package",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId"
   ],
   "query": [],
   "body": [
    {
     "name": "body",
     "type": "string",
     "required": true
    },
    {
     "name": "mentioned_user_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/work-packages#post-v1-app-project-projects-id-work-packages-wpid-comments"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId/comments/:commentId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId/comments/:commentId",
   "summary": "Edit a work-package comment",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId",
    "commentId"
   ],
   "query": [],
   "body": [
    {
     "name": "body",
     "type": "string",
     "required": true
    }
   ],
   "docs": "/developers/reference/projects/work-packages#patch-v1-app-project-projects-id-work-packages-wpid-comments-commentid"
  },
  {
   "section": "projects",
   "resource": "work-packages",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/work-packages/:wpId/comments/:commentId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/work-packages/:wpId/comments/:commentId",
   "summary": "Delete a work-package comment (soft delete)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "wpId",
    "commentId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/work-packages#delete-v1-app-project-projects-id-work-packages-wpid-comments-commentid"
  },
  {
   "section": "projects",
   "resource": "documents",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/documents",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/documents",
   "summary": "List a project's documents (Wiki)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/documents#get-v1-app-project-projects-id-documents"
  },
  {
   "section": "projects",
   "resource": "documents",
   "method": "POST",
   "path": "/v1/app/project/projects/:id/documents",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/documents",
   "summary": "Create a document. Requires at least member role on the project",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": true
    },
    {
     "name": "content",
     "type": "any",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/documents#post-v1-app-project-projects-id-documents"
  },
  {
   "section": "projects",
   "resource": "documents",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/documents/:docId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/documents/:docId",
   "summary": "Get a single document, including its content",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "docId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/documents#get-v1-app-project-projects-id-documents-docid"
  },
  {
   "section": "projects",
   "resource": "documents",
   "method": "PATCH",
   "path": "/v1/app/project/projects/:id/documents/:docId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/documents/:docId",
   "summary": "Update a document. Requires at least member role on the project",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "docId"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "content",
     "type": "any",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "position",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/documents#patch-v1-app-project-projects-id-documents-docid"
  },
  {
   "section": "projects",
   "resource": "documents",
   "method": "DELETE",
   "path": "/v1/app/project/projects/:id/documents/:docId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/documents/:docId",
   "summary": "Delete a document (soft delete)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id",
    "docId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/documents#delete-v1-app-project-projects-id-documents-docid"
  },
  {
   "section": "projects",
   "resource": "projects",
   "method": "GET",
   "path": "/v1/app/project/projects/:id/activity",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/projects/:id/activity",
   "summary": "List a project's recent activity log",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/projects#get-v1-app-project-projects-id-activity"
  },
  {
   "section": "projects",
   "resource": "admin",
   "method": "GET",
   "path": "/v1/app/project/admin/overview",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/admin/overview",
   "summary": "Tenant-wide project stats overview (for BRM-Admin)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects.",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/admin#get-v1-app-project-admin-overview"
  },
  {
   "section": "projects",
   "resource": "admin",
   "method": "GET",
   "path": "/v1/app/project/admin/projects",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/admin/projects",
   "summary": "List every project in the tenant (for BRM-Admin)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects.",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/projects/admin#get-v1-app-project-admin-projects"
  },
  {
   "section": "projects",
   "resource": "admin",
   "method": "PATCH",
   "path": "/v1/app/project/admin/projects/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/project/admin/projects/:id",
   "summary": "Archive or reactivate any project in the tenant (for BRM-Admin)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Projects.",
    "Role: `GLOBAL_ADMIN`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "status",
     "type": "string: \"active\" \\| \"archived\"",
     "required": false
    }
   ],
   "docs": "/developers/reference/projects/admin#patch-v1-app-project-admin-projects-id"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "GET",
   "path": "/v1/app/todo/lists",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists",
   "summary": "List the caller's ToDo lists",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/todo/lists#get-v1-app-todo-lists"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "POST",
   "path": "/v1/app/todo/lists",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists",
   "summary": "Create a list. Creator becomes the list's owner",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/todo/lists#post-v1-app-todo-lists"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "PATCH",
   "path": "/v1/app/todo/lists/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id",
   "summary": "Update a list's name, icon, color or position",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": true
    },
    {
     "name": "position",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/todo/lists#patch-v1-app-todo-lists-id"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "DELETE",
   "path": "/v1/app/todo/lists/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id",
   "summary": "Delete a list. Requires owner role on the list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/todo/lists#delete-v1-app-todo-lists-id"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "GET",
   "path": "/v1/app/todo/lists/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/members",
   "summary": "List a list's owner and members",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/todo/lists#get-v1-app-todo-lists-id-members"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "GET",
   "path": "/v1/app/todo/lists/:id/available-users",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/available-users",
   "summary": "List tenant staff users not already on the list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/todo/lists#get-v1-app-todo-lists-id-available-users"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "POST",
   "path": "/v1/app/todo/lists/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/members",
   "summary": "Add a member to a list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "role",
     "type": "string: \"viewer\" \\| \"editor\"",
     "required": false
    }
   ],
   "docs": "/developers/reference/todo/lists#post-v1-app-todo-lists-id-members"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "PATCH",
   "path": "/v1/app/todo/lists/:id/members/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/members/:userId",
   "summary": "Change a member's role",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id",
    "userId"
   ],
   "query": [],
   "body": [
    {
     "name": "role",
     "type": "string: \"viewer\" \\| \"editor\"",
     "required": false
    }
   ],
   "docs": "/developers/reference/todo/lists#patch-v1-app-todo-lists-id-members-userid"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "DELETE",
   "path": "/v1/app/todo/lists/:id/members/:userId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/members/:userId",
   "summary": "Remove a member from a list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id",
    "userId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/todo/lists#delete-v1-app-todo-lists-id-members-userid"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "GET",
   "path": "/v1/app/todo/lists/:id/tasks",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks",
   "summary": "List a list's (non-deleted) tasks",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/todo/lists#get-v1-app-todo-lists-id-tasks"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "POST",
   "path": "/v1/app/todo/lists/:id/tasks",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks",
   "summary": "Add a task to a list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": true
    },
    {
     "name": "notes",
     "type": "array of any",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "priority",
     "type": "any",
     "required": false
    },
    {
     "name": "due_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "recurrence",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/todo/lists#post-v1-app-todo-lists-id-tasks"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "PATCH",
   "path": "/v1/app/todo/lists/:id/tasks/:taskId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks/:taskId",
   "summary": "Update a task's fields",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id",
    "taskId"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "notes",
     "type": "array of any",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "priority",
     "type": "any",
     "required": false
    },
    {
     "name": "due_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "recurrence",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/todo/lists#patch-v1-app-todo-lists-id-tasks-taskid"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "PATCH",
   "path": "/v1/app/todo/lists/:id/tasks/:taskId/move",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks/:taskId/move",
   "summary": "Move a task between status columns or reorder it within one",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id",
    "taskId"
   ],
   "query": [],
   "body": [
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "position",
     "type": "integer",
     "required": true
    }
   ],
   "docs": "/developers/reference/todo/lists#patch-v1-app-todo-lists-id-tasks-taskid-move"
  },
  {
   "section": "todo",
   "resource": "lists",
   "method": "DELETE",
   "path": "/v1/app/todo/lists/:id/tasks/:taskId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks/:taskId",
   "summary": "Soft-delete a task. Requires editor or owner role on the list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: To Do."
   ],
   "params": [
    "id",
    "taskId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/todo/lists#delete-v1-app-todo-lists-id-tasks-taskid"
  },
  {
   "section": "wiki",
   "resource": "images",
   "method": "GET",
   "path": "/v1/app/kb/images/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/images/:id",
   "summary": "Serve image by ID (no auth required so <img> tags work)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/images#get-v1-app-kb-images-id"
  },
  {
   "section": "wiki",
   "resource": "search",
   "method": "GET",
   "path": "/v1/app/kb/me",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/me",
   "summary": "Current user's identity + personal space status (used by frontend)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/search#get-v1-app-kb-me"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "GET",
   "path": "/v1/app/kb/spaces",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces",
   "summary": "Spaces (role-based visibility) GET all spaces (role-based visibility)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/spaces#get-v1-app-kb-spaces"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "GET",
   "path": "/v1/app/kb/spaces/slug/:slug",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces/slug/:slug",
   "summary": "By slug",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "slug"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/spaces#get-v1-app-kb-spaces-slug-slug"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "GET",
   "path": "/v1/app/kb/spaces/:space_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces/:space_id",
   "summary": "Space (checks ACL)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/spaces#get-v1-app-kb-spaces-space-id"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "POST",
   "path": "/v1/app/kb/spaces",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces",
   "summary": "CREATE space - Shared spaces: global admin only - Personal spaces: any tenant user, limited to one per user",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "slug",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "color_hex",
     "type": "any",
     "required": false
    },
    {
     "name": "icon_emoji",
     "type": "any",
     "required": false
    },
    {
     "name": "is_internal_only",
     "type": "boolean",
     "required": false
    },
    {
     "name": "space_type",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/spaces#post-v1-app-kb-spaces"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "PUT",
   "path": "/v1/app/kb/spaces/:space_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces/:space_id",
   "summary": "UPDATE space (need manage permission)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "slug",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "color_hex",
     "type": "any",
     "required": false
    },
    {
     "name": "icon_emoji",
     "type": "any",
     "required": false
    },
    {
     "name": "is_internal_only",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/spaces#put-v1-app-kb-spaces-space-id"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "DELETE",
   "path": "/v1/app/kb/spaces/:space_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces/:space_id",
   "summary": "Space (need manage permission)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/spaces#delete-v1-app-kb-spaces-space-id"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "GET",
   "path": "/v1/app/kb/spaces/:space_id/collections",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces/:space_id/collections",
   "summary": "Collections in a space (requires read on space)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/spaces#get-v1-app-kb-spaces-space-id-collections"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "GET",
   "path": "/v1/app/kb/collections/slug/:slug",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/slug/:slug",
   "summary": "By slug",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "slug"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/collections#get-v1-app-kb-collections-slug-slug"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "GET",
   "path": "/v1/app/kb/collections/:collection_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id",
   "summary": "Collection (check ACL on collection)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/collections#get-v1-app-kb-collections-collection-id"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "POST",
   "path": "/v1/app/kb/spaces/:space_id/collections",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces/:space_id/collections",
   "summary": "CREATE collection in a space (need write/manage space)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "slug",
     "type": "string",
     "required": true
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "sort_order",
     "type": "integer",
     "required": false
    },
    {
     "name": "icon_emoji",
     "type": "any",
     "required": false
    },
    {
     "name": "color_hex",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/spaces#post-v1-app-kb-spaces-space-id-collections"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "PUT",
   "path": "/v1/app/kb/collections/:collection_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id",
   "summary": "UPDATE collection (need manage on collection or space)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "slug",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "sort_order",
     "type": "integer",
     "required": false
    },
    {
     "name": "icon_emoji",
     "type": "any",
     "required": false
    },
    {
     "name": "color_hex",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/collections#put-v1-app-kb-collections-collection-id"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "DELETE",
   "path": "/v1/app/kb/collections/:collection_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id",
   "summary": "Collection",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/collections#delete-v1-app-kb-collections-collection-id"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "GET",
   "path": "/v1/app/kb/collections/:collection_id/articles",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id/articles",
   "summary": "In a collection (read on space or collection)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/collections#get-v1-app-kb-collections-collection-id-articles"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/articles/slug/:slug",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/slug/:slug",
   "summary": "By slug",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "slug"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-articles-slug-slug"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/articles/:article_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id",
   "summary": "Article (ACL)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-articles-article-id"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "POST",
   "path": "/v1/app/kb/collections/:collection_id/articles",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id/articles",
   "summary": "CREATE article in a collection (write on collection/space)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": true
    },
    {
     "name": "slug",
     "type": "string",
     "required": true
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "review_interval_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "owner_user_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/collections#post-v1-app-kb-collections-collection-id-articles"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "PUT",
   "path": "/v1/app/kb/articles/:article_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id",
   "summary": "UPDATE article metadata (write on article/collection/space)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "slug",
     "type": "string",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "review_interval_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "owner_user_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "space_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "collection_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/articles#put-v1-app-kb-articles-article-id"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "DELETE",
   "path": "/v1/app/kb/articles/:article_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id",
   "summary": "Article",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#delete-v1-app-kb-articles-article-id"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/articles/:article_id/content",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/content",
   "summary": "Content (same read checks as article)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-articles-article-id-content"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/articles/:article_id/versions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/versions",
   "summary": "Versions (requires read)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-articles-article-id-versions"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/articles/:article_id/versions/:version_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/versions/:version_id",
   "summary": "Version (read)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id",
    "version_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-articles-article-id-versions-version-id"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "POST",
   "path": "/v1/app/kb/articles/:article_id/versions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/versions",
   "summary": "CREATE new version (write)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": true
    },
    {
     "name": "content_markdown",
     "type": "any",
     "required": true
    },
    {
     "name": "content_html",
     "type": "any",
     "required": false
    },
    {
     "name": "change_summary",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/articles#post-v1-app-kb-articles-article-id-versions"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "DELETE",
   "path": "/v1/app/kb/articles/:article_id/versions/:version_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/versions/:version_id",
   "summary": "(write/manage)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id",
    "version_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#delete-v1-app-kb-articles-article-id-versions-version-id"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/tags",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/tags",
   "summary": "Tags for tenant (any authenticated user)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-tags"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "POST",
   "path": "/v1/app/kb/tags",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/tags",
   "summary": "Create tag (Global Admin)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": true
    },
    {
     "name": "slug",
     "type": "string",
     "required": true
    },
    {
     "name": "color_hex",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/articles#post-v1-app-kb-tags"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "PUT",
   "path": "/v1/app/kb/tags/:tag_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/tags/:tag_id",
   "summary": "Update tag (Global Admin)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "tag_id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "slug",
     "type": "string",
     "required": false
    },
    {
     "name": "color_hex",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/articles#put-v1-app-kb-tags-tag-id"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "DELETE",
   "path": "/v1/app/kb/tags/:tag_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/tags/:tag_id",
   "summary": "(Global Admin)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "tag_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#delete-v1-app-kb-tags-tag-id"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/articles/:article_id/tags",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/tags",
   "summary": "For an article (requires read on article)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-articles-article-id-tags"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "POST",
   "path": "/v1/app/kb/articles/:article_id/tags",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/tags",
   "summary": "Set tags for an article (overwrite) – requires write on article",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [
    {
     "name": "tag_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/articles#post-v1-app-kb-articles-article-id-tags"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/articles/:article_id/comments",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/comments",
   "summary": "For article (requires read)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-articles-article-id-comments"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "POST",
   "path": "/v1/app/kb/articles/:article_id/comments",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/:article_id/comments",
   "summary": "Create comment (requires read on article, usually fine for Reader+)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [
    {
     "name": "body",
     "type": "any",
     "required": true
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/articles#post-v1-app-kb-articles-article-id-comments"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "PUT",
   "path": "/v1/app/kb/comments/:comment_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/comments/:comment_id",
   "summary": "Update comment (Global Admin or comment owner)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "comment_id"
   ],
   "query": [],
   "body": [
    {
     "name": "body",
     "type": "any",
     "required": false
    },
    {
     "name": "resolved",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/articles#put-v1-app-kb-comments-comment-id"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "DELETE",
   "path": "/v1/app/kb/comments/:comment_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/comments/:comment_id",
   "summary": "(Global Admin or owner)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "comment_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#delete-v1-app-kb-comments-comment-id"
  },
  {
   "section": "wiki",
   "resource": "search",
   "method": "GET",
   "path": "/v1/app/kb/search",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/search",
   "summary": "Search published articles",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [
    "q",
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/wiki/search#get-v1-app-kb-search"
  },
  {
   "section": "wiki",
   "resource": "search",
   "method": "GET",
   "path": "/v1/app/kb/stats",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/stats",
   "summary": "WiKi statistics",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/search#get-v1-app-kb-stats"
  },
  {
   "section": "wiki",
   "resource": "articles",
   "method": "GET",
   "path": "/v1/app/kb/articles/trending",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/articles/trending",
   "summary": "Most recently updated articles (as \"trending\")",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/articles#get-v1-app-kb-articles-trending"
  },
  {
   "section": "wiki",
   "resource": "permissions",
   "method": "GET",
   "path": "/v1/app/kb/permissions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/permissions",
   "summary": "List permissions",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [
    "object_type",
    "object_id"
   ],
   "body": [],
   "docs": "/developers/reference/wiki/permissions#get-v1-app-kb-permissions"
  },
  {
   "section": "wiki",
   "resource": "permissions",
   "method": "POST",
   "path": "/v1/app/kb/permissions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/permissions",
   "summary": "Create / update a permission entry POST /permissions body: { object_type, object_id, subject_type, subject_id, can_read, can_write, can_manage, is_denied }",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "object_type",
     "type": "string",
     "required": false
    },
    {
     "name": "object_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "subject_type",
     "type": "string",
     "required": false
    },
    {
     "name": "subject_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "can_read",
     "type": "boolean",
     "required": false
    },
    {
     "name": "can_write",
     "type": "boolean",
     "required": false
    },
    {
     "name": "can_manage",
     "type": "boolean",
     "required": false
    },
    {
     "name": "is_denied",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/wiki/permissions#post-v1-app-kb-permissions"
  },
  {
   "section": "wiki",
   "resource": "permissions",
   "method": "DELETE",
   "path": "/v1/app/kb/permissions/:perm_id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/permissions/:perm_id",
   "summary": "Remove a permission",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "perm_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/permissions#delete-v1-app-kb-permissions-perm-id"
  },
  {
   "section": "wiki",
   "resource": "permissions",
   "method": "GET",
   "path": "/v1/app/kb/subjects/users",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/subjects/users",
   "summary": "Find people (for permission pickers)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/wiki/permissions#get-v1-app-kb-subjects-users"
  },
  {
   "section": "wiki",
   "resource": "permissions",
   "method": "GET",
   "path": "/v1/app/kb/subjects/groups",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/subjects/groups",
   "summary": "Find groups (for permission pickers)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/wiki/permissions#get-v1-app-kb-subjects-groups"
  },
  {
   "section": "wiki",
   "resource": "images",
   "method": "POST",
   "path": "/v1/app/kb/images",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/images",
   "summary": "Upload an image (multipart/form-data, field name: \"image\")",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/images#post-v1-app-kb-images"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "POST",
   "path": "/v1/app/kb/spaces/:space_id/banner",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces/:space_id/banner",
   "summary": "Space banner",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/spaces#post-v1-app-kb-spaces-space-id-banner"
  },
  {
   "section": "wiki",
   "resource": "spaces",
   "method": "DELETE",
   "path": "/v1/app/kb/spaces/:space_id/banner",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/spaces/:space_id/banner",
   "summary": "Remove a space's banner",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/spaces#delete-v1-app-kb-spaces-space-id-banner"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "POST",
   "path": "/v1/app/kb/collections/:collection_id/banner",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id/banner",
   "summary": "Collection banner",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/collections#post-v1-app-kb-collections-collection-id-banner"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "DELETE",
   "path": "/v1/app/kb/collections/:collection_id/banner",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id/banner",
   "summary": "Remove a collection's banner",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/collections#delete-v1-app-kb-collections-collection-id-banner"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "POST",
   "path": "/v1/app/kb/collections/:collection_id/logo",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id/logo",
   "summary": "Collection logo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/collections#post-v1-app-kb-collections-collection-id-logo"
  },
  {
   "section": "wiki",
   "resource": "collections",
   "method": "DELETE",
   "path": "/v1/app/kb/collections/:collection_id/logo",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/collections/:collection_id/logo",
   "summary": "Remove a collection's logo",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/collections#delete-v1-app-kb-collections-collection-id-logo"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "GET",
   "path": "/v1/app/kb/admin/collections",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/collections",
   "summary": "Collections across all spaces (admin only)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/admin#get-v1-app-kb-admin-collections"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "GET",
   "path": "/v1/app/kb/admin/articles",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/articles",
   "summary": "Articles across all spaces (admin only), filterable by status",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [
    "status"
   ],
   "body": [],
   "docs": "/developers/reference/wiki/admin#get-v1-app-kb-admin-articles"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "GET",
   "path": "/v1/app/kb/admin/archived",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/archived",
   "summary": "Archived items for the tenant (global admin only)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/admin#get-v1-app-kb-admin-archived"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "POST",
   "path": "/v1/app/kb/admin/spaces/:space_id/restore",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/spaces/:space_id/restore",
   "summary": "RESTORE archived space",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/admin#post-v1-app-kb-admin-spaces-space-id-restore"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "DELETE",
   "path": "/v1/app/kb/admin/spaces/:space_id/purge",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/spaces/:space_id/purge",
   "summary": "PERMANENTLY delete archived space",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "space_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/admin#delete-v1-app-kb-admin-spaces-space-id-purge"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "POST",
   "path": "/v1/app/kb/admin/collections/:collection_id/restore",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/collections/:collection_id/restore",
   "summary": "RESTORE archived collection",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/admin#post-v1-app-kb-admin-collections-collection-id-restore"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "DELETE",
   "path": "/v1/app/kb/admin/collections/:collection_id/purge",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/collections/:collection_id/purge",
   "summary": "PERMANENTLY delete archived collection",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "collection_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/admin#delete-v1-app-kb-admin-collections-collection-id-purge"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "POST",
   "path": "/v1/app/kb/admin/articles/:article_id/restore",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/articles/:article_id/restore",
   "summary": "RESTORE archived article",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/admin#post-v1-app-kb-admin-articles-article-id-restore"
  },
  {
   "section": "wiki",
   "resource": "admin",
   "method": "DELETE",
   "path": "/v1/app/kb/admin/articles/:article_id/purge",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/kb/admin/articles/:article_id/purge",
   "summary": "PERMANENTLY delete archived article",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: WiKi."
   ],
   "params": [
    "article_id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/wiki/admin#delete-v1-app-kb-admin-articles-article-id-purge"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "GET",
   "path": "/v1/app/forms/forms",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms",
   "summary": "List this tenant's forms with response counts",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/forms#get-v1-app-forms-forms"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "POST",
   "path": "/v1/app/forms/forms",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms",
   "summary": "Create a draft form with one default page",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/forms#post-v1-app-forms-forms"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id",
   "summary": "Full structure for the builder (pages, fields, logic)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/forms#get-v1-app-forms-forms-id"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "PUT",
   "path": "/v1/app/forms/forms/:id/structure",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/structure",
   "summary": "Bulk save: replaces pages/fields/logic in one transaction (delete-then-reinsert)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "pages",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/forms#put-v1-app-forms-forms-id-structure"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "PATCH",
   "path": "/v1/app/forms/forms/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id",
   "summary": "Update title/description/status/require_login/theme",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "key",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/forms#patch-v1-app-forms-forms-id"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "DELETE",
   "path": "/v1/app/forms/forms/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id",
   "summary": "Soft delete",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/forms#delete-v1-app-forms-forms-id"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "POST",
   "path": "/v1/app/forms/forms/:id/publish",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/publish",
   "summary": "Go live at /f/:slug",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/forms#post-v1-app-forms-forms-id-publish"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "POST",
   "path": "/v1/app/forms/forms/:id/close",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/close",
   "summary": "Stop accepting new responses",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/forms#post-v1-app-forms-forms-id-close"
  },
  {
   "section": "forms",
   "resource": "collaborators",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/collaborators",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/collaborators",
   "summary": "Owner + current collaborator list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/collaborators#get-v1-app-forms-forms-id-collaborators"
  },
  {
   "section": "forms",
   "resource": "collaborators",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/collaborators/available",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/collaborators/available",
   "summary": "Tenant users not already the owner or a collaborator, for the \"add collaborator\" picker",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/forms/collaborators#get-v1-app-forms-forms-id-collaborators-available"
  },
  {
   "section": "forms",
   "resource": "collaborators",
   "method": "POST",
   "path": "/v1/app/forms/forms/:id/collaborators",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/collaborators",
   "summary": "Add a collaborator. Owner only",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/collaborators#post-v1-app-forms-forms-id-collaborators"
  },
  {
   "section": "forms",
   "resource": "collaborators",
   "method": "DELETE",
   "path": "/v1/app/forms/forms/:id/collaborators/:collabId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/collaborators/:collabId",
   "summary": "Owner only",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id",
    "collabId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/collaborators#delete-v1-app-forms-forms-id-collaborators-collabid"
  },
  {
   "section": "forms",
   "resource": "collaborators",
   "method": "PATCH",
   "path": "/v1/app/forms/forms/:id/owner",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/owner",
   "summary": "Transfer ownership. Owner only; the new owner must already be a collaborator (promotes them and drops the old owner down to collaborator, so they don't lose …",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/collaborators#patch-v1-app-forms-forms-id-owner"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/submissions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/submissions",
   "summary": "Paginated list",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [
    "page",
    "pageSize"
   ],
   "body": [],
   "docs": "/developers/reference/forms/submissions#get-v1-app-forms-forms-id-submissions"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/submissions/export",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/submissions/export",
   "summary": "CSV export (register before the :subId route below so \"export\" isn't parsed as a submission id)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/submissions#get-v1-app-forms-forms-id-submissions-export"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/submissions/:subId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/submissions/:subId",
   "summary": "Full detail",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id",
    "subId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/submissions#get-v1-app-forms-forms-id-submissions-subid"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "DELETE",
   "path": "/v1/app/forms/forms/:id/submissions",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/submissions",
   "summary": "Bulk delete, body: { ids: [1,2,3] }",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/submissions#delete-v1-app-forms-forms-id-submissions"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "DELETE",
   "path": "/v1/app/forms/forms/:id/submissions/:subId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/submissions/:subId",
   "summary": "Single delete",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id",
    "subId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/submissions#delete-v1-app-forms-forms-id-submissions-subid"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/stats",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/stats",
   "summary": "Response dashboard stat tiles",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/forms#get-v1-app-forms-forms-id-stats"
  },
  {
   "section": "forms",
   "resource": "forms",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/summary",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/summary",
   "summary": "Per-question breakdown for the responses \"Summary\" tab: option counts for choice-type fields, top keywords for free-text ones",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/forms#get-v1-app-forms-forms-id-summary"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/uploads/:uploadId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/uploads/:uploadId",
   "summary": "Auth-gated file-answer download",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id",
    "uploadId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/submissions#get-v1-app-forms-forms-id-uploads-uploadid"
  },
  {
   "section": "forms",
   "resource": "images",
   "method": "POST",
   "path": "/v1/app/forms/images",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/images",
   "summary": "Upload a theme background/banner image (multipart, field \"image\")",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/images#post-v1-app-forms-images"
  },
  {
   "section": "forms",
   "resource": "images",
   "method": "GET",
   "path": "/v1/app/forms/images/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/images/:id",
   "summary": "Public, no auth (theme images embedded via <img>/CSS background-image)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/images#get-v1-app-forms-images-id"
  },
  {
   "section": "forms",
   "resource": "public",
   "method": "GET",
   "path": "/v1/app/forms/public/:slug",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/public/:slug",
   "summary": "A published form's structure/theme (404 if draft/closed) optionalAuth so alreadySubmitted can be reported for one-response-per-user forms without requiring t…",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "slug"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/public#get-v1-app-forms-public-slug"
  },
  {
   "section": "forms",
   "resource": "public",
   "method": "POST",
   "path": "/v1/app/forms/public/:slug/submit",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/public/:slug/submit",
   "summary": "Submit a response. FormData shape: `answers` = JSON string { [fieldId]: value|value[] }, plus one file part per file-type field named `file_<fieldId>`",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "slug"
   ],
   "query": [],
   "body": [
    {
     "name": "answers",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/public#post-v1-app-forms-public-slug-submit"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "GET",
   "path": "/v1/app/forms/forms/:id/submissions/:subId/links",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/submissions/:subId/links",
   "summary": "A response's links to other records",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id",
    "subId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/submissions#get-v1-app-forms-forms-id-submissions-subid-links"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "POST",
   "path": "/v1/app/forms/forms/:id/submissions/:subId/links",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/submissions/:subId/links",
   "summary": "Link a response to a record in another app",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id",
    "subId"
   ],
   "query": [],
   "body": [
    {
     "name": "target_app",
     "type": "string: \"project\" \\| \"todo\"",
     "required": false
    },
    {
     "name": "target_id",
     "type": "number",
     "required": true
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/submissions#post-v1-app-forms-forms-id-submissions-subid-links"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "DELETE",
   "path": "/v1/app/forms/forms/:id/submissions/:subId/links/:linkId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/:id/submissions/:subId/links/:linkId",
   "summary": "Remove a link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [
    "id",
    "subId",
    "linkId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/forms/submissions#delete-v1-app-forms-forms-id-submissions-subid-links-linkid"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "POST",
   "path": "/v1/app/forms/forms/links",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/links",
   "summary": "Same as the nested create above, but keyed by submission_id alone (no form_id needed in the URL)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Forms."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "submission_id",
     "type": "number",
     "required": true
    },
    {
     "name": "target_app",
     "type": "string: \"project\" \\| \"todo\"",
     "required": false
    },
    {
     "name": "target_id",
     "type": "number",
     "required": true
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/forms/submissions#post-v1-app-forms-forms-links"
  },
  {
   "section": "forms",
   "resource": "submissions",
   "method": "GET",
   "path": "/v1/app/forms/forms/links/for-target",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/forms/forms/links/for-target",
   "summary": "The reverse lookup, called from BRM-Project/BRM-ToDo to show what submissions link to a given work package/task",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [
    "target_app",
    "target_id"
   ],
   "body": [],
   "docs": "/developers/reference/forms/submissions#get-v1-app-forms-forms-links-for-target"
  },
  {
   "section": "drive",
   "resource": "office",
   "method": "GET",
   "path": "/wopi/files/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/wopi/files/:id",
   "summary": "File details for the editor (WOPI CheckFileInfo)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/office#get-wopi-files-id"
  },
  {
   "section": "drive",
   "resource": "office",
   "method": "GET",
   "path": "/wopi/files/:id/contents",
   "url": "https://<your-org>.brambleit.cloud/drive/wopi/files/:id/contents",
   "summary": "File contents for the editor (WOPI GetFile)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/office#get-wopi-files-id-contents"
  },
  {
   "section": "drive",
   "resource": "office",
   "method": "POST",
   "path": "/wopi/files/:id/contents",
   "url": "https://<your-org>.brambleit.cloud/drive/wopi/files/:id/contents",
   "summary": "Save from the editor (WOPI PutFile)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/office#post-wopi-files-id-contents"
  },
  {
   "section": "drive",
   "resource": "office",
   "method": "POST",
   "path": "/wopi/files/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/wopi/files/:id",
   "summary": "Other editor requests (WOPI)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/office#post-wopi-files-id"
  },
  {
   "section": "drive",
   "resource": "public-links",
   "method": "GET",
   "path": "/api/public/:token",
   "url": "https://<your-org>.brambleit.cloud/drive/api/public/:token",
   "summary": "Open a share link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [
    "item"
   ],
   "body": [],
   "docs": "/developers/reference/drive/public-links#get-api-public-token"
  },
  {
   "section": "drive",
   "resource": "public-links",
   "method": "POST",
   "path": "/api/public/:token/unlock",
   "url": "https://<your-org>.brambleit.cloud/drive/api/public/:token/unlock",
   "summary": "Unlock a password-protected share link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [
    {
     "name": "password",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/public-links#post-api-public-token-unlock"
  },
  {
   "section": "drive",
   "resource": "public-links",
   "method": "GET",
   "path": "/api/public/:token/content",
   "url": "https://<your-org>.brambleit.cloud/drive/api/public/:token/content",
   "summary": "Download from a share link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [
    "item",
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/drive/public-links#get-api-public-token-content"
  },
  {
   "section": "drive",
   "resource": "public-links",
   "method": "GET",
   "path": "/api/public/:token/thumb",
   "url": "https://<your-org>.brambleit.cloud/drive/api/public/:token/thumb",
   "summary": "Thumbnail from a share link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [
    "item",
    "s"
   ],
   "body": [],
   "docs": "/developers/reference/drive/public-links#get-api-public-token-thumb"
  },
  {
   "section": "drive",
   "resource": "sync",
   "method": "GET",
   "path": "/api/v2/sync/spaces",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/sync/spaces",
   "summary": "Spaces you can sync",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/sync#get-api-v2-sync-spaces"
  },
  {
   "section": "drive",
   "resource": "sync",
   "method": "GET",
   "path": "/api/v2/sync/changes",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/sync/changes",
   "summary": "Changes in a space since a cursor",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "space",
    "cursor",
    "after",
    "wait"
   ],
   "body": [],
   "docs": "/developers/reference/drive/sync#get-api-v2-sync-changes"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/me",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/me",
   "summary": "Who you are and your Drive settings",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-me"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/usage",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/usage",
   "summary": "Your storage use",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-usage"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/list",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/list",
   "summary": "List a folder",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "parent",
    "parent_id",
    "site",
    "site_id"
   ],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-list"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/recent",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/recent",
   "summary": "Recent files",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-recent"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/starred",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/starred",
   "summary": "Starred items",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-starred"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/shared",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/shared",
   "summary": "Shared with you",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-shared"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/shared-by-me",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/shared-by-me",
   "summary": "Shared by you",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-shared-by-me"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/search",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/search",
   "summary": "Search files and folders",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "q",
    "type"
   ],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-search"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "GET",
   "path": "/api/v2/items/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id",
   "summary": "Get an item",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#get-api-v2-items-id"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "GET",
   "path": "/api/v2/items/:id/content",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/content",
   "summary": "Download a file",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [
    "v",
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/drive/items#get-api-v2-items-id-content"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "GET",
   "path": "/api/v2/items/:id/thumb",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/thumb",
   "summary": "A file's thumbnail",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [
    "s"
   ],
   "body": [],
   "docs": "/developers/reference/drive/items#get-api-v2-items-id-thumb"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "PATCH",
   "path": "/api/v2/items/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id",
   "summary": "Rename an item",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#patch-api-v2-items-id"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/items/:id/star",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/star",
   "summary": "Star or unstar an item",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "on",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#post-api-v2-items-id-star"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "GET",
   "path": "/api/v2/items/:id/versions",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/versions",
   "summary": "A file's versions",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#get-api-v2-items-id-versions"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/items/:id/versions/:vid/restore",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/versions/:vid/restore",
   "summary": "Restore an older version",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id",
    "vid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#post-api-v2-items-id-versions-vid-restore"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "DELETE",
   "path": "/api/v2/items/:id/versions/:vid",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/versions/:vid",
   "summary": "Delete an older version",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id",
    "vid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#delete-api-v2-items-id-versions-vid"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "GET",
   "path": "/api/v2/items/:id/activity",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/activity",
   "summary": "An item's activity",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#get-api-v2-items-id-activity"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "GET",
   "path": "/api/v2/items/:id/sharing",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/sharing",
   "summary": "Who an item is shared with",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#get-api-v2-items-id-sharing"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/items/:id/sharing/grants",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/sharing/grants",
   "summary": "Share an item with a person or group",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "id",
     "type": "integer",
     "required": false
    },
    {
     "name": "role",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#post-api-v2-items-id-sharing-grants"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "PATCH",
   "path": "/api/v2/items/:id/sharing/grants/:gid",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/sharing/grants/:gid",
   "summary": "Change someone's access to an item",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id",
    "gid"
   ],
   "query": [],
   "body": [
    {
     "name": "role",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#patch-api-v2-items-id-sharing-grants-gid"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "DELETE",
   "path": "/api/v2/items/:id/sharing/grants/:gid",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/sharing/grants/:gid",
   "summary": "Stop sharing an item with someone",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id",
    "gid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#delete-api-v2-items-id-sharing-grants-gid"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/items/:id/sharing/links",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/sharing/links",
   "summary": "Create a share link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "expires_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "password",
     "type": "any",
     "required": false
    },
    {
     "name": "allow_download",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#post-api-v2-items-id-sharing-links"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "DELETE",
   "path": "/api/v2/items/:id/sharing/links/:lid",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/sharing/links/:lid",
   "summary": "Delete a share link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id",
    "lid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#delete-api-v2-items-id-sharing-links-lid"
  },
  {
   "section": "drive",
   "resource": "quick-share",
   "method": "POST",
   "path": "/api/v2/quick-share",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/quick-share",
   "summary": "Quick share: start (where to upload), then finish (expiry + link)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "batch",
     "type": "any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/quick-share#post-api-v2-quick-share"
  },
  {
   "section": "drive",
   "resource": "quick-share",
   "method": "POST",
   "path": "/api/v2/quick-share/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/quick-share/:id",
   "summary": "Change a quick share's link",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "days",
     "type": "array of any",
     "required": false
    },
    {
     "name": "password",
     "type": "any",
     "required": false
    },
    {
     "name": "allow_download",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/quick-share#post-api-v2-quick-share-id"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/items/:id/keep",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/items/:id/keep",
   "summary": "Keep a file out of the bin's automatic clean-up",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/items#post-api-v2-items-id-keep"
  },
  {
   "section": "drive",
   "resource": "browse",
   "method": "GET",
   "path": "/api/v2/people",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/people",
   "summary": "Find people and groups to share with",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/drive/browse#get-api-v2-people"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/folders",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/folders",
   "summary": "Create a folder",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "parent",
     "type": "any",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "site",
     "type": "any",
     "required": false
    },
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#post-api-v2-folders"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/folders/ensure",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/folders/ensure",
   "summary": "Make sure a folder path exists",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "parent",
     "type": "any",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "site",
     "type": "any",
     "required": false
    },
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "path",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#post-api-v2-folders-ensure"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/move",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/move",
   "summary": "Move items",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "parent",
     "type": "any",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "site",
     "type": "any",
     "required": false
    },
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#post-api-v2-move"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "POST",
   "path": "/api/v2/copy",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/copy",
   "summary": "Copy items",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "parent",
     "type": "any",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "site",
     "type": "any",
     "required": false
    },
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/items#post-api-v2-copy"
  },
  {
   "section": "drive",
   "resource": "trash",
   "method": "POST",
   "path": "/api/v2/trash",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/trash",
   "summary": "Move items to the bin",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/trash#post-api-v2-trash"
  },
  {
   "section": "drive",
   "resource": "trash",
   "method": "GET",
   "path": "/api/v2/trash",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/trash",
   "summary": "List the bin",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "site"
   ],
   "body": [],
   "docs": "/developers/reference/drive/trash#get-api-v2-trash"
  },
  {
   "section": "drive",
   "resource": "trash",
   "method": "POST",
   "path": "/api/v2/trash/:id/restore",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/trash/:id/restore",
   "summary": "Restore an item from the bin",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/trash#post-api-v2-trash-id-restore"
  },
  {
   "section": "drive",
   "resource": "trash",
   "method": "DELETE",
   "path": "/api/v2/trash/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/trash/:id",
   "summary": "Delete an item for good",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/trash#delete-api-v2-trash-id"
  },
  {
   "section": "drive",
   "resource": "trash",
   "method": "DELETE",
   "path": "/api/v2/trash",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/trash",
   "summary": "Empty the bin",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "site"
   ],
   "body": [],
   "docs": "/developers/reference/drive/trash#delete-api-v2-trash"
  },
  {
   "section": "drive",
   "resource": "items",
   "method": "GET",
   "path": "/api/v2/zip",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/zip",
   "summary": "Download items as a zip",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "ids"
   ],
   "body": [],
   "docs": "/developers/reference/drive/items#get-api-v2-zip"
  },
  {
   "section": "drive",
   "resource": "uploads",
   "method": "POST",
   "path": "/api/v2/uploads/check",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/uploads/check",
   "summary": "Which of these names already exist in a folder (so the client can ask \"replace or keep both\" before uploading)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "parent",
     "type": "any",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "site",
     "type": "any",
     "required": false
    },
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "names",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/uploads#post-api-v2-uploads-check"
  },
  {
   "section": "drive",
   "resource": "uploads",
   "method": "POST",
   "path": "/api/v2/upload",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/upload",
   "summary": "Upload a small file",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "parent",
    "parent_id",
    "site",
    "site_id",
    "name",
    "conflict"
   ],
   "body": [],
   "docs": "/developers/reference/drive/uploads#post-api-v2-upload"
  },
  {
   "section": "drive",
   "resource": "uploads",
   "method": "POST",
   "path": "/api/v2/uploads",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/uploads",
   "summary": "Start a resumable upload",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "size",
     "type": "number",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "conflict",
     "type": "string",
     "required": false
    },
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "part_size",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/uploads#post-api-v2-uploads"
  },
  {
   "section": "drive",
   "resource": "uploads",
   "method": "GET",
   "path": "/api/v2/uploads/:uid",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/uploads/:uid",
   "summary": "Which parts of an upload have arrived",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "uid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/uploads#get-api-v2-uploads-uid"
  },
  {
   "section": "drive",
   "resource": "uploads",
   "method": "PUT",
   "path": "/api/v2/uploads/:uid/parts/:n",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/uploads/:uid/parts/:n",
   "summary": "Send one part of an upload",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "uid",
    "n"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/uploads#put-api-v2-uploads-uid-parts-n"
  },
  {
   "section": "drive",
   "resource": "uploads",
   "method": "POST",
   "path": "/api/v2/uploads/:uid/complete",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/uploads/:uid/complete",
   "summary": "Finish a resumable upload",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "uid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/uploads#post-api-v2-uploads-uid-complete"
  },
  {
   "section": "drive",
   "resource": "uploads",
   "method": "DELETE",
   "path": "/api/v2/uploads/:uid",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/uploads/:uid",
   "summary": "Abandon an upload",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "uid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/uploads#delete-api-v2-uploads-uid"
  },
  {
   "section": "drive",
   "resource": "libraries",
   "method": "GET",
   "path": "/api/v2/libraries",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/libraries",
   "summary": "List libraries",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/libraries#get-api-v2-libraries"
  },
  {
   "section": "drive",
   "resource": "libraries",
   "method": "POST",
   "path": "/api/v2/libraries",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/libraries",
   "summary": "Create a library",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/libraries#post-api-v2-libraries"
  },
  {
   "section": "drive",
   "resource": "libraries",
   "method": "GET",
   "path": "/api/v2/libraries/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id",
   "summary": "Get a library",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/libraries#get-api-v2-libraries-id"
  },
  {
   "section": "drive",
   "resource": "libraries",
   "method": "PATCH",
   "path": "/api/v2/libraries/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id",
   "summary": "Update a library",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/libraries#patch-api-v2-libraries-id"
  },
  {
   "section": "drive",
   "resource": "libraries",
   "method": "DELETE",
   "path": "/api/v2/libraries/:id",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id",
   "summary": "Delete a library",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/libraries#delete-api-v2-libraries-id"
  },
  {
   "section": "drive",
   "resource": "libraries",
   "method": "GET",
   "path": "/api/v2/libraries/:id/members",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id/members",
   "summary": "A library's members",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/libraries#get-api-v2-libraries-id-members"
  },
  {
   "section": "drive",
   "resource": "libraries",
   "method": "PUT",
   "path": "/api/v2/libraries/:id/members",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id/members",
   "summary": "Add or change a library member",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "id",
     "type": "number",
     "required": false
    },
    {
     "name": "role",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/libraries#put-api-v2-libraries-id-members"
  },
  {
   "section": "drive",
   "resource": "libraries",
   "method": "DELETE",
   "path": "/api/v2/libraries/:id/members/:type/:mid",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id/members/:type/:mid",
   "summary": "Remove a library member",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id",
    "type",
    "mid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/libraries#delete-api-v2-libraries-id-members-type-mid"
  },
  {
   "section": "drive",
   "resource": "office",
   "method": "GET",
   "path": "/api/v2/office/config",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/office/config",
   "summary": "Which Office apps you can use",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/office#get-api-v2-office-config"
  },
  {
   "section": "drive",
   "resource": "office",
   "method": "GET",
   "path": "/api/v2/office/recent",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/office/recent",
   "summary": "The Docs / Sheets / Slides start pages: that kind's files the person can reach (their drive, their libraries, shared with them), newest first",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [
    "app",
    "kind",
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/drive/office#get-api-v2-office-recent"
  },
  {
   "section": "drive",
   "resource": "office",
   "method": "POST",
   "path": "/api/v2/office/:id/session",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/office/:id/session",
   "summary": "Opens a file in the editor: the URL to post to and the token to post",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "mode",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/office#post-api-v2-office-id-session"
  },
  {
   "section": "drive",
   "resource": "office",
   "method": "POST",
   "path": "/api/v2/office/new",
   "url": "https://<your-org>.brambleit.cloud/drive/api/v2/office/new",
   "summary": "A new blank Word document, spreadsheet or presentation in a folder",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Drive."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "kind",
     "type": "string",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/office#post-api-v2-office-new"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/drive/items",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/items",
   "summary": "List items in a folder",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [
    "parent_id"
   ],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#get-v1-app-drive-items"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/drive/recent",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/recent",
   "summary": "List the caller's 20 most recently updated files",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#get-v1-app-drive-recent"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/drive/search",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/search",
   "summary": "Search the caller's items by name",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#get-v1-app-drive-search"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/drive/quota",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/quota",
   "summary": "Get the caller's personal storage quota and usage",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#get-v1-app-drive-quota"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/drive/item/:id/path",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/item/:id/path",
   "summary": "Get the breadcrumb path to an item",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#get-v1-app-drive-item-id-path"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/drive/folder",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/folder",
   "summary": "Create a folder. If parent_id is given it must be an existing, non-deleted item belonging to the caller's tenant",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/legacy-v1#post-v1-app-drive-folder"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "PATCH",
   "path": "/v1/app/drive/item/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/item/:id",
   "summary": "Rename an item. Only affects items owned (created_by) by the caller",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/legacy-v1#patch-v1-app-drive-item-id"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/drive/item/:id/move",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/item/:id/move",
   "summary": "Move an item into a different folder",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/legacy-v1#post-v1-app-drive-item-id-move"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "DELETE",
   "path": "/v1/app/drive/item/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/item/:id",
   "summary": "Move an item to trash",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#delete-v1-app-drive-item-id"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/drive/trash",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/trash",
   "summary": "List the caller's trashed items",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#get-v1-app-drive-trash"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/drive/trash/restore/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/trash/restore/:id",
   "summary": "Restore an item out of trash",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#post-v1-app-drive-trash-restore-id"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/drive/item/:id/share",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/item/:id/share",
   "summary": "Create a public share link for a file",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "expires_at",
     "type": "string (date-time)",
     "required": false
    }
   ],
   "docs": "/developers/reference/drive/legacy-v1#post-v1-app-drive-item-id-share"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/drive/item/:id/shares",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/item/:id/shares",
   "summary": "List active share links for an item",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#get-v1-app-drive-item-id-shares"
  },
  {
   "section": "drive",
   "resource": "legacy-v1",
   "method": "DELETE",
   "path": "/v1/app/drive/share/:token",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/drive/share/:token",
   "summary": "Revoke a share link. Only affects shares on items owned by the caller",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/drive/legacy-v1#delete-v1-app-drive-share-token"
  },
  {
   "section": "sites",
   "resource": "api-endpoints",
   "method": "POST",
   "path": "/api/upload/:siteId",
   "url": "https://<your-org>.brambleit.cloud/sites/api/upload/:siteId",
   "summary": "Upload a file to a site library (Sync)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "siteId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/api-endpoints#post-api-upload-siteid"
  },
  {
   "section": "sites",
   "resource": "api-endpoints",
   "method": "PATCH",
   "path": "/api/item/:itemId/content",
   "url": "https://<your-org>.brambleit.cloud/sites/api/item/:itemId/content",
   "summary": "Replace a file's contents (Sync)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "itemId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/api-endpoints#patch-api-item-itemid-content"
  },
  {
   "section": "sites",
   "resource": "api-endpoints",
   "method": "GET",
   "path": "/api/download/:itemId",
   "url": "https://<your-org>.brambleit.cloud/sites/api/download/:itemId",
   "summary": "Download a file (Sync)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "itemId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/api-endpoints#get-api-download-itemid"
  },
  {
   "section": "sites",
   "resource": "api-endpoints",
   "method": "GET",
   "path": "/api/preview/:itemId",
   "url": "https://<your-org>.brambleit.cloud/sites/api/preview/:itemId",
   "summary": "Preview a file (Sync)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "itemId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/api-endpoints#get-api-preview-itemid"
  },
  {
   "section": "sites",
   "resource": "api-endpoints",
   "method": "DELETE",
   "path": "/api/trash/:itemId",
   "url": "https://<your-org>.brambleit.cloud/sites/api/trash/:itemId",
   "summary": "Move a file to the bin (Sync)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "itemId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/api-endpoints#delete-api-trash-itemid"
  },
  {
   "section": "sites",
   "resource": "api-endpoints",
   "method": "DELETE",
   "path": "/api/site/:siteId/trash",
   "url": "https://<your-org>.brambleit.cloud/sites/api/site/:siteId/trash",
   "summary": "Empty a site library's bin (Sync)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "siteId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/api-endpoints#delete-api-site-siteid-trash"
  },
  {
   "section": "sites",
   "resource": "home",
   "method": "GET",
   "path": "/api/v2/me",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/me",
   "summary": "Who you are: the signed-in person and what they can do here",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/home#get-api-v2-me"
  },
  {
   "section": "sites",
   "resource": "home",
   "method": "GET",
   "path": "/api/v2/home",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/home",
   "summary": "Your sites home page",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/home#get-api-v2-home"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "GET",
   "path": "/api/v2/sites",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites",
   "summary": "List sites you can see",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/sites/sites#get-api-v2-sites"
  },
  {
   "section": "sites",
   "resource": "home",
   "method": "GET",
   "path": "/api/v2/search",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/search",
   "summary": "Search sites and pages",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/sites/home#get-api-v2-search"
  },
  {
   "section": "sites",
   "resource": "home",
   "method": "GET",
   "path": "/api/v2/news",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/news",
   "summary": "News from your sites",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [
    "scope",
    "limit",
    "offset"
   ],
   "body": [],
   "docs": "/developers/reference/sites/home#get-api-v2-news"
  },
  {
   "section": "sites",
   "resource": "home",
   "method": "GET",
   "path": "/api/v2/people",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/people",
   "summary": "Find people",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/sites/home#get-api-v2-people"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "POST",
   "path": "/api/v2/sites",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites",
   "summary": "Create a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "privacy",
     "type": "any",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": false
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/sites#post-api-v2-sites"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "GET",
   "path": "/api/v2/sites/:ref",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:ref",
   "summary": "Get a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "ref"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/sites#get-api-v2-sites-ref"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "PATCH",
   "path": "/api/v2/sites/:id",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id",
   "summary": "Update a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": false
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    },
    {
     "name": "header",
     "type": "string: \"standard\" \\| \"compact\" \\| \"banner\"",
     "required": false
    },
    {
     "name": "privacy",
     "type": "string",
     "required": false
    },
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "nav",
     "type": "any",
     "required": false
    },
    {
     "name": "slug",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/sites#patch-api-v2-sites-id"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "DELETE",
   "path": "/api/v2/sites/:id",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id",
   "summary": "Delete a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/sites#delete-api-v2-sites-id"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "POST",
   "path": "/api/v2/sites/:id/follow",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/follow",
   "summary": "Follow or unfollow a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "on",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/sites#post-api-v2-sites-id-follow"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "GET",
   "path": "/api/v2/sites/:id/members",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/members",
   "summary": "A site's members",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/sites#get-api-v2-sites-id-members"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "PUT",
   "path": "/api/v2/sites/:id/members",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/members",
   "summary": "Add or change a member",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "id",
     "type": "number",
     "required": false
    },
    {
     "name": "role",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/sites#put-api-v2-sites-id-members"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "DELETE",
   "path": "/api/v2/sites/:id/members/:type/:pid",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/members/:type/:pid",
   "summary": "Remove a member",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "type",
    "pid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/sites#delete-api-v2-sites-id-members-type-pid"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "POST",
   "path": "/api/v2/sites/:id/libraries",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/libraries",
   "summary": "Add a document library",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/sites#post-api-v2-sites-id-libraries"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "PATCH",
   "path": "/api/v2/sites/:id/libraries/:lid",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/libraries/:lid",
   "summary": "Rename a document library",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "lid"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/sites#patch-api-v2-sites-id-libraries-lid"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "DELETE",
   "path": "/api/v2/sites/:id/libraries/:lid",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/libraries/:lid",
   "summary": "Delete a document library",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "lid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/sites#delete-api-v2-sites-id-libraries-lid"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "GET",
   "path": "/api/v2/sites/:id/pages",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/pages",
   "summary": "A site's pages",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [
    "kind"
   ],
   "body": [],
   "docs": "/developers/reference/sites/sites#get-api-v2-sites-id-pages"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "POST",
   "path": "/api/v2/sites/:id/pages",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/pages",
   "summary": "Create a page or news post",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "kind",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/sites#post-api-v2-sites-id-pages"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "GET",
   "path": "/api/v2/sites/:ref/page/:slug",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:ref/page/:slug",
   "summary": "Get a page by its address",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "ref",
    "slug"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/sites#get-api-v2-sites-ref-page-slug"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "GET",
   "path": "/api/v2/sites/:id/news",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/news",
   "summary": "A site's news",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [
    "limit",
    "offset"
   ],
   "body": [],
   "docs": "/developers/reference/sites/sites#get-api-v2-sites-id-news"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "GET",
   "path": "/api/v2/pages/:id",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id",
   "summary": "Get a page",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/pages#get-api-v2-pages-id"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "PUT",
   "path": "/api/v2/pages/:id/draft",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/draft",
   "summary": "Save a page's draft",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "content",
     "type": "any",
     "required": false
    },
    {
     "name": "banner_asset_id",
     "type": "number",
     "required": false
    },
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "summary",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/pages#put-api-v2-pages-id-draft"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "POST",
   "path": "/api/v2/pages/:id/publish",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/publish",
   "summary": "Publish a page's draft",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/pages#post-api-v2-pages-id-publish"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "POST",
   "path": "/api/v2/pages/:id/discard",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/discard",
   "summary": "Throw away a page's draft",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/pages#post-api-v2-pages-id-discard"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "DELETE",
   "path": "/api/v2/pages/:id",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id",
   "summary": "Delete a page",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/pages#delete-api-v2-pages-id"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "POST",
   "path": "/api/v2/pages/:id/home",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/home",
   "summary": "Make a page the site's home page",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/pages#post-api-v2-pages-id-home"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "POST",
   "path": "/api/v2/pages/:id/pin",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/pin",
   "summary": "Pin or unpin a news post",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "on",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/pages#post-api-v2-pages-id-pin"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "GET",
   "path": "/api/v2/pages/:id/versions",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/versions",
   "summary": "A page's published versions",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/pages#get-api-v2-pages-id-versions"
  },
  {
   "section": "sites",
   "resource": "pages",
   "method": "POST",
   "path": "/api/v2/pages/:id/versions/:vid/restore",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/versions/:vid/restore",
   "summary": "Restore a published version",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "vid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/pages#post-api-v2-pages-id-versions-vid-restore"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "GET",
   "path": "/api/v2/sites/:id/blocks/files",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/blocks/files",
   "summary": "Files for a Files block",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [
    "library",
    "folder",
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/sites/sites#get-api-v2-sites-id-blocks-files"
  },
  {
   "section": "sites",
   "resource": "blocks",
   "method": "GET",
   "path": "/api/v2/blocks/people",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/blocks/people",
   "summary": "People for a People block",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [
    "ids"
   ],
   "body": [],
   "docs": "/developers/reference/sites/blocks#get-api-v2-blocks-people"
  },
  {
   "section": "sites",
   "resource": "blocks",
   "method": "POST",
   "path": "/api/v2/blocks/embed-check",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/blocks/embed-check",
   "summary": "Can this address be embedded?",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "url",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/blocks#post-api-v2-blocks-embed-check"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "GET",
   "path": "/api/v2/sites/:id/libraries/:lid/folders",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/libraries/:lid/folders",
   "summary": "Folders of a site library, for the Files block's folder picker",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "lid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/sites#get-api-v2-sites-id-libraries-lid-folders"
  },
  {
   "section": "sites",
   "resource": "sites",
   "method": "POST",
   "path": "/api/v2/sites/:id/assets",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/sites/:id/assets",
   "summary": "Upload an image",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/sites#post-api-v2-sites-id-assets"
  },
  {
   "section": "sites",
   "resource": "blocks",
   "method": "GET",
   "path": "/api/v2/assets/:id",
   "url": "https://<your-org>.brambleit.cloud/sites/api/v2/assets/:id",
   "summary": "Get an image",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/blocks#get-api-v2-assets-id"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites",
   "summary": "List sites the caller is a member of",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#get-v1-app-sites"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/sites",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites",
   "summary": "Create a site. Creator is automatically added as a drive_site_members row with role owner",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/legacy-v1#post-v1-app-sites"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "DELETE",
   "path": "/v1/app/sites/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id",
   "summary": "Soft-delete a site. Requires owner role on the site (drive_site_members)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#delete-v1-app-sites-id"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/sites/:id/quota",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/quota",
   "summary": "Get a site's storage usage against the tenant's shared site-storage pool",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#get-v1-app-sites-id-quota"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/sites/:id/items",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/items",
   "summary": "List items in a site folder",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [
    "parent_id"
   ],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#get-v1-app-sites-id-items"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/sites/:id/item/:itemId/path",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/item/:itemId/path",
   "summary": "Get the breadcrumb path to an item within a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "itemId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#get-v1-app-sites-id-item-itemid-path"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/sites/:id/folder",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/folder",
   "summary": "Create a folder within a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/legacy-v1#post-v1-app-sites-id-folder"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "PATCH",
   "path": "/v1/app/sites/:id/item/:itemId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/item/:itemId",
   "summary": "Rename an item within a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "itemId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/legacy-v1#patch-v1-app-sites-id-item-itemid"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/sites/:id/item/:itemId/move",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/item/:itemId/move",
   "summary": "Move an item into a different folder within a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "itemId"
   ],
   "query": [],
   "body": [
    {
     "name": "parent_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/legacy-v1#post-v1-app-sites-id-item-itemid-move"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "DELETE",
   "path": "/v1/app/sites/:id/item/:itemId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/item/:itemId",
   "summary": "Soft-delete an item within a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "itemId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#delete-v1-app-sites-id-item-itemid"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/sites/:id/trash",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/trash",
   "summary": "List trashed items within a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#get-v1-app-sites-id-trash"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/sites/:id/trash/restore/:itemId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/trash/restore/:itemId",
   "summary": "Restore an item out of trash within a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "itemId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#post-v1-app-sites-id-trash-restore-itemid"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/sites/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/members",
   "summary": "List a site's members",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#get-v1-app-sites-id-members"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "POST",
   "path": "/v1/app/sites/:id/members",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/members",
   "summary": "Add or update a site member",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "user_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "role",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/sites/legacy-v1#post-v1-app-sites-id-members"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "DELETE",
   "path": "/v1/app/sites/:id/member/:targetUserId",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/member/:targetUserId",
   "summary": "Remove a member from a site",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id",
    "targetUserId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#delete-v1-app-sites-id-member-targetuserid"
  },
  {
   "section": "sites",
   "resource": "legacy-v1",
   "method": "GET",
   "path": "/v1/app/sites/:id/search",
   "url": "https://<your-org>.brambleit.cloud/api/v1/app/sites/:id/search",
   "summary": "Search a site's items by name",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: Sites."
   ],
   "params": [
    "id"
   ],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/sites/legacy-v1#get-v1-app-sites-id-search"
  },
  {
   "section": "mail",
   "resource": "me",
   "method": "GET",
   "path": "/api/app/version",
   "url": "https://<your-org>.brambleit.cloud/mail/api/app/version",
   "summary": "Latest Android app version",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/me#get-api-app-version"
  },
  {
   "section": "mail",
   "resource": "me",
   "method": "GET",
   "path": "/api/app/bramble-mail.apk",
   "url": "https://<your-org>.brambleit.cloud/mail/api/app/bramble-mail.apk",
   "summary": "Download the Android app",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/me#get-api-app-bramble-mail-apk"
  },
  {
   "section": "mail",
   "resource": "caldav-carddav",
   "method": "OPTIONS",
   "path": "/dav/*",
   "url": "https://<your-org>.brambleit.cloud/mail/dav/*",
   "summary": "CalDAV/CardDAV capabilities",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/caldav-carddav#options-dav"
  },
  {
   "section": "mail",
   "resource": "caldav-carddav",
   "method": "ALL",
   "path": "/dav/*",
   "url": "https://<your-org>.brambleit.cloud/mail/dav/*",
   "summary": "CalDAV and CardDAV",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/caldav-carddav#all-dav"
  },
  {
   "section": "mail",
   "resource": "caldav-carddav",
   "method": "GET",
   "path": "/ics/:file",
   "url": "https://<your-org>.brambleit.cloud/mail/ics/:file",
   "summary": "Read a calendar from its .ics link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "file"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/caldav-carddav#get-ics-file"
  },
  {
   "section": "mail",
   "resource": "caldav-carddav",
   "method": "ALL",
   "path": "/.well-known/caldav",
   "url": "https://<your-org>.brambleit.cloud/mail/.well-known/caldav",
   "summary": "CalDAV discovery",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/caldav-carddav#all-well-known-caldav"
  },
  {
   "section": "mail",
   "resource": "caldav-carddav",
   "method": "ALL",
   "path": "/.well-known/carddav",
   "url": "https://<your-org>.brambleit.cloud/mail/.well-known/carddav",
   "summary": "CardDAV discovery",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/caldav-carddav#all-well-known-carddav"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "GET",
   "path": "/api/cal/bootstrap",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/bootstrap",
   "summary": "Everything the calendar page needs to start",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#get-api-cal-bootstrap"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "PATCH",
   "path": "/api/cal/prefs",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/prefs",
   "summary": "Save calendar preferences",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "view",
     "type": "string: \"day\" \\| \"week\" \\| \"month\" \\| \"agenda\"",
     "required": false
    },
    {
     "name": "weekStart",
     "type": "number",
     "required": false
    },
    {
     "name": "dayStart",
     "type": "number",
     "required": false
    },
    {
     "name": "timezone",
     "type": "any",
     "required": false
    },
    {
     "name": "feeds",
     "type": "object",
     "required": false
    },
    {
     "name": "feedColors",
     "type": "object",
     "required": false
    },
    {
     "name": "hidden",
     "type": "array of any",
     "required": false
    },
    {
     "name": "rooms",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/calendar#patch-api-cal-prefs"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "POST",
   "path": "/api/cal/calendars",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars",
   "summary": "Create a calendar",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": false
    },
    {
     "name": "uri",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/calendar#post-api-cal-calendars"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "PATCH",
   "path": "/api/cal/calendars/:id",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id",
   "summary": "Update a calendar",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": false
    },
    {
     "name": "sort",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/calendar#patch-api-cal-calendars-id"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "DELETE",
   "path": "/api/cal/calendars/:id",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id",
   "summary": "Delete a calendar",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#delete-api-cal-calendars-id"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "POST",
   "path": "/api/cal/calendars/:id/subscription",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/subscription",
   "summary": "Make a private .ics link",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#post-api-cal-calendars-id-subscription"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "DELETE",
   "path": "/api/cal/calendars/:id/subscription",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/subscription",
   "summary": "Stop a calendar's .ics link",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#delete-api-cal-calendars-id-subscription"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "GET",
   "path": "/api/cal/calendars/:id/shares",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/shares",
   "summary": "Who a calendar is shared with",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#get-api-cal-calendars-id-shares"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "POST",
   "path": "/api/cal/calendars/:id/shares",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/shares",
   "summary": "Share a calendar",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "id",
     "type": "integer",
     "required": false
    },
    {
     "name": "level",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/calendar#post-api-cal-calendars-id-shares"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "DELETE",
   "path": "/api/cal/calendars/:id/shares/:share",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/shares/:share",
   "summary": "Stop sharing a calendar with someone",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id",
    "share"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#delete-api-cal-calendars-id-shares-share"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "GET",
   "path": "/api/cal/people",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/people",
   "summary": "People (and groups) in your organisation, plus your own contacts",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "q",
    "groups",
    "contacts",
    "rooms"
   ],
   "body": [],
   "docs": "/developers/reference/mail/calendar#get-api-cal-people"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "GET",
   "path": "/api/cal/rooms",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/rooms",
   "summary": "List meeting rooms",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#get-api-cal-rooms"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "POST",
   "path": "/api/cal/freebusy",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/freebusy",
   "summary": "Busy times for people in your organisation and rooms",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "from",
     "type": "any",
     "required": false
    },
    {
     "name": "to",
     "type": "any",
     "required": false
    },
    {
     "name": "addresses",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/calendar#post-api-cal-freebusy"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "POST",
   "path": "/api/cal/calendars/:id/import",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/import",
   "summary": "Import an .ics file into a calendar (each event becomes its own entry)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#post-api-cal-calendars-id-import"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "GET",
   "path": "/api/cal/calendars/:id/export.ics",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/export.ics",
   "summary": "Export a calendar as .ics",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#get-api-cal-calendars-id-export-ics"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "GET",
   "path": "/api/cal/events",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/events",
   "summary": "Events in a time range",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "from",
    "to"
   ],
   "body": [],
   "docs": "/developers/reference/mail/calendar#get-api-cal-events"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "POST",
   "path": "/api/cal/calendars/:id/events",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/events",
   "summary": "Create an event",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "attendees",
     "type": "array of any",
     "required": false
    },
    {
     "name": "tz",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/calendar#post-api-cal-calendars-id-events"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "PATCH",
   "path": "/api/cal/calendars/:id/events/:uri",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/events/:uri",
   "summary": "Change an event",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id",
    "uri"
   ],
   "query": [],
   "body": [
    {
     "name": "etag",
     "type": "any",
     "required": false
    },
    {
     "name": "attendees",
     "type": "array of any",
     "required": false
    },
    {
     "name": "rsvp",
     "type": "any",
     "required": false
    },
    {
     "name": "scope",
     "type": "string",
     "required": false
    },
    {
     "name": "recurrenceId",
     "type": "any",
     "required": false
    },
    {
     "name": "tz",
     "type": "any",
     "required": false
    },
    {
     "name": "moveTo",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/calendar#patch-api-cal-calendars-id-events-uri"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "DELETE",
   "path": "/api/cal/calendars/:id/events/:uri",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/calendars/:id/events/:uri",
   "summary": "Delete an event",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id",
    "uri"
   ],
   "query": [
    "scope",
    "recurrenceId"
   ],
   "body": [],
   "docs": "/developers/reference/mail/calendar#delete-api-cal-calendars-id-events-uri"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "GET",
   "path": "/api/cal/categories",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/categories",
   "summary": "List categories",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#get-api-cal-categories"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "POST",
   "path": "/api/cal/categories",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/categories",
   "summary": "Create a category",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "id",
     "type": "integer",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "color",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/calendar#post-api-cal-categories"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "PATCH",
   "path": "/api/cal/categories/:id",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/categories/:id",
   "summary": "Update a category",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#patch-api-cal-categories-id"
  },
  {
   "section": "mail",
   "resource": "calendar",
   "method": "DELETE",
   "path": "/api/cal/categories/:id",
   "url": "https://<your-org>.brambleit.cloud/mail/api/cal/categories/:id",
   "summary": "Delete a category",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/calendar#delete-api-cal-categories-id"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "GET",
   "path": "/api/contacts/bootstrap",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/bootstrap",
   "summary": "Everything the contacts page needs to start",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#get-api-contacts-bootstrap"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "GET",
   "path": "/api/contacts/directory",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/directory",
   "summary": "The organisation directory",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#get-api-contacts-directory"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "POST",
   "path": "/api/contacts/books",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books",
   "summary": "Create a book",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "uri",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/contacts#post-api-contacts-books"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "PATCH",
   "path": "/api/contacts/books/:id",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books/:id",
   "summary": "Rename an address book",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#patch-api-contacts-books-id"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "DELETE",
   "path": "/api/contacts/books/:id",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books/:id",
   "summary": "Delete an address book",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#delete-api-contacts-books-id"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "GET",
   "path": "/api/contacts/books/:id/contacts",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books/:id/contacts",
   "summary": "List contacts of a book",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#get-api-contacts-books-id-contacts"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "POST",
   "path": "/api/contacts/books/:id/contacts",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books/:id/contacts",
   "summary": "Add a contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#post-api-contacts-books-id-contacts"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "PATCH",
   "path": "/api/contacts/books/:id/contacts/:uri",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books/:id/contacts/:uri",
   "summary": "Update a contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id",
    "uri"
   ],
   "query": [],
   "body": [
    {
     "name": "etag",
     "type": "any",
     "required": false
    },
    {
     "name": "moveTo",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/contacts#patch-api-contacts-books-id-contacts-uri"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "DELETE",
   "path": "/api/contacts/books/:id/contacts/:uri",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books/:id/contacts/:uri",
   "summary": "Delete a contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id",
    "uri"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#delete-api-contacts-books-id-contacts-uri"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "POST",
   "path": "/api/contacts/books/:id/import",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books/:id/import",
   "summary": "Import a .vcf file (one or many cards)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#post-api-contacts-books-id-import"
  },
  {
   "section": "mail",
   "resource": "contacts",
   "method": "GET",
   "path": "/api/contacts/books/:id/export.vcf",
   "url": "https://<your-org>.brambleit.cloud/mail/api/contacts/books/:id/export.vcf",
   "summary": "Export an address book (.vcf)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/contacts#get-api-contacts-books-id-export-vcf"
  },
  {
   "section": "mail",
   "resource": "rooms-admin",
   "method": "GET",
   "path": "/api/admin/rooms",
   "url": "https://<your-org>.brambleit.cloud/mail/api/admin/rooms",
   "summary": "List rooms",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/rooms-admin#get-api-admin-rooms"
  },
  {
   "section": "mail",
   "resource": "rooms-admin",
   "method": "POST",
   "path": "/api/admin/rooms",
   "url": "https://<your-org>.brambleit.cloud/mail/api/admin/rooms",
   "summary": "Create a room",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "email",
     "type": "string",
     "required": false
    },
    {
     "name": "capacity",
     "type": "string",
     "required": false
    },
    {
     "name": "location",
     "type": "any",
     "required": false
    },
    {
     "name": "notes",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/rooms-admin#post-api-admin-rooms"
  },
  {
   "section": "mail",
   "resource": "rooms-admin",
   "method": "PATCH",
   "path": "/api/admin/rooms/:id",
   "url": "https://<your-org>.brambleit.cloud/mail/api/admin/rooms/:id",
   "summary": "Update a room",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/rooms-admin#patch-api-admin-rooms-id"
  },
  {
   "section": "mail",
   "resource": "rooms-admin",
   "method": "DELETE",
   "path": "/api/admin/rooms/:id",
   "url": "https://<your-org>.brambleit.cloud/mail/api/admin/rooms/:id",
   "summary": "Deleting a room drops its bookings; meetings keep it on their list",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/rooms-admin#delete-api-admin-rooms-id"
  },
  {
   "section": "mail",
   "resource": "rooms-admin",
   "method": "GET",
   "path": "/api/admin/rooms/:id/bookings",
   "url": "https://<your-org>.brambleit.cloud/mail/api/admin/rooms/:id/bookings",
   "summary": "A room's bookings (next 60 days) for the admin page",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/rooms-admin#get-api-admin-rooms-id-bookings"
  },
  {
   "section": "mail",
   "resource": "me",
   "method": "GET",
   "path": "/api/me",
   "url": "https://<your-org>.brambleit.cloud/mail/api/me",
   "summary": "Your mailboxes and addresses",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/mail/me#get-api-me"
  },
  {
   "section": "mail",
   "resource": "folders",
   "method": "GET",
   "path": "/api/folders",
   "url": "https://<your-org>.brambleit.cloud/mail/api/folders",
   "summary": "List a mailbox's folders",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "mb"
   ],
   "body": [],
   "docs": "/developers/reference/mail/folders#get-api-folders"
  },
  {
   "section": "mail",
   "resource": "folders",
   "method": "POST",
   "path": "/api/folders",
   "url": "https://<your-org>.brambleit.cloud/mail/api/folders",
   "summary": "Create a folder",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "parent",
     "type": "any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/folders#post-api-folders"
  },
  {
   "section": "mail",
   "resource": "folders",
   "method": "PATCH",
   "path": "/api/folders",
   "url": "https://<your-org>.brambleit.cloud/mail/api/folders",
   "summary": "Rename or move a folder",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "path",
     "type": "string",
     "required": false
    },
    {
     "name": "parent",
     "type": "any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/folders#patch-api-folders"
  },
  {
   "section": "mail",
   "resource": "folders",
   "method": "DELETE",
   "path": "/api/folders",
   "url": "https://<your-org>.brambleit.cloud/mail/api/folders",
   "summary": "Delete a folder",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "path",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/folders#delete-api-folders"
  },
  {
   "section": "mail",
   "resource": "folders",
   "method": "PUT",
   "path": "/api/folders/order",
   "url": "https://<your-org>.brambleit.cloud/mail/api/folders/order",
   "summary": "Save the folder order",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "order",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/folders#put-api-folders-order"
  },
  {
   "section": "mail",
   "resource": "folders",
   "method": "GET",
   "path": "/api/rules",
   "url": "https://<your-org>.brambleit.cloud/mail/api/rules",
   "summary": "List mail rules",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "mb"
   ],
   "body": [],
   "docs": "/developers/reference/mail/folders#get-api-rules"
  },
  {
   "section": "mail",
   "resource": "folders",
   "method": "PUT",
   "path": "/api/rules",
   "url": "https://<your-org>.brambleit.cloud/mail/api/rules",
   "summary": "Save mail rules",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "rules",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/folders#put-api-rules"
  },
  {
   "section": "mail",
   "resource": "messages",
   "method": "GET",
   "path": "/api/messages",
   "url": "https://<your-org>.brambleit.cloud/mail/api/messages",
   "summary": "List messages in a folder",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "mb",
    "folder",
    "page",
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/mail/messages#get-api-messages"
  },
  {
   "section": "mail",
   "resource": "messages",
   "method": "GET",
   "path": "/api/message",
   "url": "https://<your-org>.brambleit.cloud/mail/api/message",
   "summary": "Read a message",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "mb",
    "folder",
    "uid",
    "remote"
   ],
   "body": [],
   "docs": "/developers/reference/mail/messages#get-api-message"
  },
  {
   "section": "mail",
   "resource": "messages",
   "method": "GET",
   "path": "/api/invite",
   "url": "https://<your-org>.brambleit.cloud/mail/api/invite",
   "summary": "A meeting invitation in a message",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "mb",
    "folder",
    "uid"
   ],
   "body": [],
   "docs": "/developers/reference/mail/messages#get-api-invite"
  },
  {
   "section": "mail",
   "resource": "messages",
   "method": "POST",
   "path": "/api/invite",
   "url": "https://<your-org>.brambleit.cloud/mail/api/invite",
   "summary": "Answer a meeting invitation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "folder",
     "type": "any",
     "required": false
    },
    {
     "name": "uid",
     "type": "any",
     "required": false
    },
    {
     "name": "action",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/messages#post-api-invite"
  },
  {
   "section": "mail",
   "resource": "messages",
   "method": "GET",
   "path": "/api/attachment",
   "url": "https://<your-org>.brambleit.cloud/mail/api/attachment",
   "summary": "Download an attachment",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "mb",
    "folder",
    "uid",
    "index"
   ],
   "body": [],
   "docs": "/developers/reference/mail/messages#get-api-attachment"
  },
  {
   "section": "mail",
   "resource": "messages",
   "method": "POST",
   "path": "/api/flags",
   "url": "https://<your-org>.brambleit.cloud/mail/api/flags",
   "summary": "Mark messages read, unread or flagged",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "folder",
     "type": "any",
     "required": false
    },
    {
     "name": "uids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "key",
     "type": "string",
     "required": false
    },
    {
     "name": "seen",
     "type": "any",
     "required": false
    },
    {
     "name": "flagged",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/messages#post-api-flags"
  },
  {
   "section": "mail",
   "resource": "messages",
   "method": "POST",
   "path": "/api/move",
   "url": "https://<your-org>.brambleit.cloud/mail/api/move",
   "summary": "Move messages",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "folder",
     "type": "any",
     "required": false
    },
    {
     "name": "to",
     "type": "any",
     "required": false
    },
    {
     "name": "uids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/messages#post-api-move"
  },
  {
   "section": "mail",
   "resource": "messages",
   "method": "POST",
   "path": "/api/delete",
   "url": "https://<your-org>.brambleit.cloud/mail/api/delete",
   "summary": "Delete messages",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "mb",
     "type": "any",
     "required": false
    },
    {
     "name": "folder",
     "type": "any",
     "required": false
    },
    {
     "name": "uids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/messages#post-api-delete"
  },
  {
   "section": "mail",
   "resource": "send",
   "method": "POST",
   "path": "/api/send",
   "url": "https://<your-org>.brambleit.cloud/mail/api/send",
   "summary": "Send a message",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "from",
     "type": "any",
     "required": false
    },
    {
     "name": "to",
     "type": "any",
     "required": false
    },
    {
     "name": "cc",
     "type": "any",
     "required": false
    },
    {
     "name": "bcc",
     "type": "any",
     "required": false
    },
    {
     "name": "html",
     "type": "any",
     "required": false
    },
    {
     "name": "subject",
     "type": "any",
     "required": false
    },
    {
     "name": "inReplyTo",
     "type": "any",
     "required": false
    },
    {
     "name": "references",
     "type": "array of any",
     "required": false
    },
    {
     "name": "answeredUid",
     "type": "number",
     "required": false
    },
    {
     "name": "answeredFolder",
     "type": "any",
     "required": false
    },
    {
     "name": "answeredMb",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/send#post-api-send"
  },
  {
   "section": "mail",
   "resource": "events",
   "method": "GET",
   "path": "/api/events",
   "url": "https://<your-org>.brambleit.cloud/mail/api/events",
   "summary": "Live mailbox changes (server-sent events)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "mb"
   ],
   "body": [],
   "docs": "/developers/reference/mail/events#get-api-events"
  },
  {
   "section": "mail",
   "resource": "events",
   "method": "GET",
   "path": "/api/push",
   "url": "https://<your-org>.brambleit.cloud/mail/api/push",
   "summary": "Keep the live connection alive",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Mail."
   ],
   "params": [],
   "query": [
    "mb",
    "ping"
   ],
   "body": [],
   "docs": "/developers/reference/mail/events#get-api-push"
  },
  {
   "section": "mail",
   "resource": "maildelivery",
   "method": "POST",
   "path": "/v1/maildelivery/new",
   "url": "https://<your-org>.brambleit.cloud/api/v1/maildelivery/new",
   "summary": "Tell Bramble about new mail (mail server only)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "user",
     "type": "any",
     "required": false
    },
    {
     "name": "messages",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/mail/maildelivery#post-v1-maildelivery-new"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "GET",
   "path": "/api/me",
   "url": "https://<your-org>.brambleit.cloud/hr/api/me",
   "summary": "Who you are: the signed-in person and what they can do here",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/people#get-api-me"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "GET",
   "path": "/api/people",
   "url": "https://<your-org>.brambleit.cloud/hr/api/people",
   "summary": "The directory",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/people#get-api-people"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "GET",
   "path": "/api/people/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/people/:id",
   "summary": "Get a person's HR record",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/people#get-api-people-id"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "PATCH",
   "path": "/api/people/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/people/:id",
   "summary": "Update a person's HR record",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "k",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/people#patch-api-people-id"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "POST",
   "path": "/api/people",
   "url": "https://<your-org>.brambleit.cloud/hr/api/people",
   "summary": "New starter (before their account exists) — HR admins only",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "first_name",
     "type": "string",
     "required": false
    },
    {
     "name": "last_name",
     "type": "string",
     "required": false
    },
    {
     "name": "work_email",
     "type": "string",
     "required": false
    },
    {
     "name": "manager_id",
     "type": "number",
     "required": false
    },
    {
     "name": "personal_email",
     "type": "string",
     "required": false
    },
    {
     "name": "job_title",
     "type": "string",
     "required": false
    },
    {
     "name": "department",
     "type": "string",
     "required": false
    },
    {
     "name": "location",
     "type": "string",
     "required": false
    },
    {
     "name": "start_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "employment_type",
     "type": "string",
     "required": false
    },
    {
     "name": "contract_type",
     "type": "string",
     "required": false
    },
    {
     "name": "work_days",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/people#post-api-people"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "DELETE",
   "path": "/api/people/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/people/:id",
   "summary": "Remove someone from HR (a mistake, a duplicate, a service account)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/people#delete-api-people-id"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "POST",
   "path": "/api/people/:id/contacts",
   "url": "https://<your-org>.brambleit.cloud/hr/api/people/:id/contacts",
   "summary": "Add an emergency contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "string",
     "required": true
    },
    {
     "name": "email",
     "type": "string",
     "required": true
    },
    {
     "name": "relationship",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/people#post-api-people-id-contacts"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "PUT",
   "path": "/api/people/:id/contacts/:cid",
   "url": "https://<your-org>.brambleit.cloud/hr/api/people/:id/contacts/:cid",
   "summary": "Update an emergency contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id",
    "cid"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "relationship",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "string",
     "required": false
    },
    {
     "name": "email",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/people#put-api-people-id-contacts-cid"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "DELETE",
   "path": "/api/people/:id/contacts/:cid",
   "url": "https://<your-org>.brambleit.cloud/hr/api/people/:id/contacts/:cid",
   "summary": "Remove an emergency contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id",
    "cid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/people#delete-api-people-id-contacts-cid"
  },
  {
   "section": "hr",
   "resource": "people",
   "method": "GET",
   "path": "/api/activity",
   "url": "https://<your-org>.brambleit.cloud/hr/api/activity",
   "summary": "Recent HR activity",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/people#get-api-activity"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "GET",
   "path": "/api/leave/balance",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/balance",
   "summary": "A person's time-off balance",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [
    "employee",
    "date"
   ],
   "body": [],
   "docs": "/developers/reference/hr/leave#get-api-leave-balance"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "GET",
   "path": "/api/leave/requests",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/requests",
   "summary": "List time-off requests",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [
    "scope",
    "employee"
   ],
   "body": [],
   "docs": "/developers/reference/hr/leave#get-api-leave-requests"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "POST",
   "path": "/api/leave/preview",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/preview",
   "summary": "How many days a request would use",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "employee_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "type_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/leave#post-api-leave-preview"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "POST",
   "path": "/api/leave/requests",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/requests",
   "summary": "Request time off",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "employee_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "type_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    },
    {
     "name": "start_date",
     "type": "any",
     "required": false
    },
    {
     "name": "end_date",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/leave#post-api-leave-requests"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "POST",
   "path": "/api/leave/requests/:id/decide",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/requests/:id/decide",
   "summary": "Approve or decline time off",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "approve",
     "type": "any",
     "required": false
    },
    {
     "name": "note",
     "type": "any",
     "required": false
    },
    {
     "name": "override",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/leave#post-api-leave-requests-id-decide"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "POST",
   "path": "/api/leave/requests/:id/cancel",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/requests/:id/cancel",
   "summary": "Cancel time off",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/leave#post-api-leave-requests-id-cancel"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "POST",
   "path": "/api/leave/adjustments",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/adjustments",
   "summary": "Add or take away days",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "employee_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "days",
     "type": "number",
     "required": false
    },
    {
     "name": "reason",
     "type": "string",
     "required": false
    },
    {
     "name": "date",
     "type": "string (date)",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/leave#post-api-leave-adjustments"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "DELETE",
   "path": "/api/leave/adjustments/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/adjustments/:id",
   "summary": "Remove an adjustment",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/leave#delete-api-leave-adjustments-id"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "POST",
   "path": "/api/leave/allowance-changes",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/allowance-changes",
   "summary": "From a leave year on, someone's allowance is `days` a year ('set') or `days` on top of the policy ('extra')",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "employee_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "kind",
     "type": "string",
     "required": false
    },
    {
     "name": "days",
     "type": "number",
     "required": true
    },
    {
     "name": "from",
     "type": "string (date)",
     "required": true
    },
    {
     "name": "reason",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/leave#post-api-leave-allowance-changes"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "DELETE",
   "path": "/api/leave/allowance-changes/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/allowance-changes/:id",
   "summary": "Remove an allowance change",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/leave#delete-api-leave-allowance-changes-id"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "GET",
   "path": "/api/leave/calendar",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/calendar",
   "summary": "Who's off when",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [
    "from",
    "to"
   ],
   "body": [],
   "docs": "/developers/reference/hr/leave#get-api-leave-calendar"
  },
  {
   "section": "hr",
   "resource": "leave",
   "method": "GET",
   "path": "/api/leave/types",
   "url": "https://<your-org>.brambleit.cloud/hr/api/leave/types",
   "summary": "Leave types",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/leave#get-api-leave-types"
  },
  {
   "section": "hr",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents",
   "url": "https://<your-org>.brambleit.cloud/hr/api/documents",
   "summary": "List documents",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [
    "employee"
   ],
   "body": [],
   "docs": "/developers/reference/hr/documents#get-api-documents"
  },
  {
   "section": "hr",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/expiring",
   "url": "https://<your-org>.brambleit.cloud/hr/api/documents/expiring",
   "summary": "HR: documents expiring in the next 60 days or already expired",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/documents#get-api-documents-expiring"
  },
  {
   "section": "hr",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents",
   "url": "https://<your-org>.brambleit.cloud/hr/api/documents",
   "summary": "Upload a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "employee_id",
     "type": "string",
     "required": false
    },
    {
     "name": "category",
     "type": "any",
     "required": false
    },
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "visible_to_employee",
     "type": "string",
     "required": false
    },
    {
     "name": "requires_ack",
     "type": "string",
     "required": false
    },
    {
     "name": "expires_on",
     "type": "string (date)",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/documents#post-api-documents"
  },
  {
   "section": "hr",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id/file",
   "url": "https://<your-org>.brambleit.cloud/hr/api/documents/:id/file",
   "summary": "Download a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/hr/documents#get-api-documents-id-file"
  },
  {
   "section": "hr",
   "resource": "documents",
   "method": "PATCH",
   "path": "/api/documents/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/documents/:id",
   "summary": "Update a document's details",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "category",
     "type": "any",
     "required": false
    },
    {
     "name": "visible_to_employee",
     "type": "any",
     "required": false
    },
    {
     "name": "requires_ack",
     "type": "any",
     "required": false
    },
    {
     "name": "expires_on",
     "type": "string (date)",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/documents#patch-api-documents-id"
  },
  {
   "section": "hr",
   "resource": "documents",
   "method": "DELETE",
   "path": "/api/documents/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/documents/:id",
   "summary": "Delete a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/documents#delete-api-documents-id"
  },
  {
   "section": "hr",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents/:id/ack",
   "url": "https://<your-org>.brambleit.cloud/hr/api/documents/:id/ack",
   "summary": "Acknowledge a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/documents#post-api-documents-id-ack"
  },
  {
   "section": "hr",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id/acks",
   "url": "https://<your-org>.brambleit.cloud/hr/api/documents/:id/acks",
   "summary": "HR: who has and hasn't acknowledged a company document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/documents#get-api-documents-id-acks"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "GET",
   "path": "/api/checklists",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists",
   "summary": "List checklists",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [
    "employee",
    "include"
   ],
   "body": [],
   "docs": "/developers/reference/hr/checklists#get-api-checklists"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "GET",
   "path": "/api/checklists/tasks/mine",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists/tasks/mine",
   "summary": "Open tasks that are the viewer's to do, across every checklist",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/checklists#get-api-checklists-tasks-mine"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "GET",
   "path": "/api/checklists/templates",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists/templates",
   "summary": "Checklist templates",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/checklists#get-api-checklists-templates"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "GET",
   "path": "/api/checklists/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists/:id",
   "summary": "Get a checklist",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/checklists#get-api-checklists-id"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "POST",
   "path": "/api/checklists",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists",
   "summary": "Start a checklist",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "employee_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "template_id",
     "type": "number",
     "required": false
    },
    {
     "name": "anchor_date",
     "type": "string (date)",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/checklists#post-api-checklists"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "POST",
   "path": "/api/checklists/:id/tasks",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists/:id/tasks",
   "summary": "Add a task",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "assignee",
     "type": "any",
     "required": false
    },
    {
     "name": "details",
     "type": "string",
     "required": false
    },
    {
     "name": "due_date",
     "type": "string (date)",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/checklists#post-api-checklists-id-tasks"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "POST",
   "path": "/api/checklists/tasks/:tid/toggle",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists/tasks/:tid/toggle",
   "summary": "Tick or untick a task",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "tid"
   ],
   "query": [],
   "body": [
    {
     "name": "done",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/hr/checklists#post-api-checklists-tasks-tid-toggle"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "DELETE",
   "path": "/api/checklists/tasks/:tid",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists/tasks/:tid",
   "summary": "Delete a task",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "tid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/checklists#delete-api-checklists-tasks-tid"
  },
  {
   "section": "hr",
   "resource": "checklists",
   "method": "DELETE",
   "path": "/api/checklists/:id",
   "url": "https://<your-org>.brambleit.cloud/hr/api/checklists/:id",
   "summary": "Cancel a checklist",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: HR."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/hr/checklists#delete-api-checklists-id"
  },
  {
   "section": "flows",
   "resource": "webhooks",
   "method": "GET",
   "path": "/hook/w/:token",
   "url": "https://<your-org>.brambleit.cloud/flows/hook/w/:token",
   "summary": "Open a form link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/webhooks#get-hook-w-token"
  },
  {
   "section": "flows",
   "resource": "webhooks",
   "method": "POST",
   "path": "/hook/w/:token",
   "url": "https://<your-org>.brambleit.cloud/flows/hook/w/:token",
   "summary": "Answer a form link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [
    {
     "name": "decision",
     "type": "string",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/webhooks#post-hook-w-token"
  },
  {
   "section": "flows",
   "resource": "webhooks",
   "method": "GET",
   "path": "/hook/a/:token",
   "url": "https://<your-org>.brambleit.cloud/flows/hook/a/:token",
   "summary": "Open an approval link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/webhooks#get-hook-a-token"
  },
  {
   "section": "flows",
   "resource": "webhooks",
   "method": "POST",
   "path": "/hook/a/:token",
   "url": "https://<your-org>.brambleit.cloud/flows/hook/a/:token",
   "summary": "Answer an approval link",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/webhooks#post-hook-a-token"
  },
  {
   "section": "flows",
   "resource": "webhooks",
   "method": "ALL",
   "path": "/hook/:token",
   "url": "https://<your-org>.brambleit.cloud/flows/hook/:token",
   "summary": "Start a flow (webhook)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/webhooks#all-hook-token"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/me",
   "url": "https://<your-org>.brambleit.cloud/flows/api/me",
   "summary": "Who you are: the signed-in person and what they can do here",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-me"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/catalogue",
   "url": "https://<your-org>.brambleit.cloud/flows/api/catalogue",
   "summary": "Steps and triggers available",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-catalogue"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/flows",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows",
   "summary": "List flows",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [
    "view"
   ],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-flows"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "POST",
   "path": "/api/flows",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows",
   "summary": "Create a flow",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "scope",
     "type": "string",
     "required": false
    },
    {
     "name": "graph",
     "type": "any",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/flows#post-api-flows"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/flows/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id",
   "summary": "Get a flow",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-flows-id"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "PUT",
   "path": "/api/flows/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id",
   "summary": "Save a flow",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "version",
     "type": "number",
     "required": false
    },
    {
     "name": "graph",
     "type": "any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "auto",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/flows#put-api-flows-id"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/subflows",
   "url": "https://<your-org>.brambleit.cloud/flows/api/subflows",
   "summary": "Sub-flows a flow may run: same scope (personal: the owner's own; organisation: organisation flows), starting \"When another flow runs it\"",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [
    "flow"
   ],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-subflows"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "POST",
   "path": "/api/flows/:id/settings",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/settings",
   "summary": "Flow settings: what happens if it's triggered while still running",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "concurrency",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/flows#post-api-flows-id-settings"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/flows/:id/versions",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/versions",
   "summary": "Version history (lib/versions.js)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-flows-id-versions"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/flows/:id/versions/:vid",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/versions/:vid",
   "summary": "Get an older version of a flow",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id",
    "vid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-flows-id-versions-vid"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "POST",
   "path": "/api/flows/:id/activate",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/activate",
   "summary": "Switch a flow on",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#post-api-flows-id-activate"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "POST",
   "path": "/api/flows/:id/deactivate",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/deactivate",
   "summary": "Switch a flow off",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#post-api-flows-id-deactivate"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "POST",
   "path": "/api/flows/:id/duplicate",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/duplicate",
   "summary": "Copy a flow",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#post-api-flows-id-duplicate"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "DELETE",
   "path": "/api/flows/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id",
   "summary": "Delete a flow",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#delete-api-flows-id"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "POST",
   "path": "/api/flows/:id/run",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/run",
   "summary": "Run now. Body: { data?, nodeId?, graph?",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "graph",
     "type": "any",
     "required": false
    },
    {
     "name": "nodeId",
     "type": "any",
     "required": false
    },
    {
     "name": "data",
     "type": "object",
     "required": false
    },
    {
     "name": "stopAt",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/flows#post-api-flows-id-run"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/flows/:id/runs",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/runs",
   "summary": "A flow's runs",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [
    "limit",
    "before",
    "status"
   ],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-flows-id-runs"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/flows/:id/checks",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/checks",
   "summary": "Checks made by polling triggers (New email), newest first: the last 3 days, including the ones that found nothing",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-flows-id-checks"
  },
  {
   "section": "flows",
   "resource": "runs",
   "method": "GET",
   "path": "/api/runs/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/runs/:id",
   "summary": "Get a run with its steps",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/runs#get-api-runs-id"
  },
  {
   "section": "flows",
   "resource": "runs",
   "method": "GET",
   "path": "/api/runs/:id/outputs/:nodeId",
   "url": "https://<your-org>.brambleit.cloud/flows/api/runs/:id/outputs/:nodeId",
   "summary": "A step's whole output from a run (the steps list only has the first 25 items) — for pinning",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id",
    "nodeId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/runs#get-api-runs-id-outputs-nodeid"
  },
  {
   "section": "flows",
   "resource": "runs",
   "method": "POST",
   "path": "/api/runs/:id/cancel",
   "url": "https://<your-org>.brambleit.cloud/flows/api/runs/:id/cancel",
   "summary": "Cancel a run",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/runs#post-api-runs-id-cancel"
  },
  {
   "section": "flows",
   "resource": "runs",
   "method": "POST",
   "path": "/api/runs/:id/retry",
   "url": "https://<your-org>.brambleit.cloud/flows/api/runs/:id/retry",
   "summary": "Run the flow again (as it is now) with the same trigger data",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/runs#post-api-runs-id-retry"
  },
  {
   "section": "flows",
   "resource": "connections",
   "method": "GET",
   "path": "/api/connection-types",
   "url": "https://<your-org>.brambleit.cloud/flows/api/connection-types",
   "summary": "Kinds of connection",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/connections#get-api-connection-types"
  },
  {
   "section": "flows",
   "resource": "connections",
   "method": "GET",
   "path": "/api/connections",
   "url": "https://<your-org>.brambleit.cloud/flows/api/connections",
   "summary": "?type=a,b  ?flow=<id> → only ones that flow could use",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [
    "flow",
    "type"
   ],
   "body": [],
   "docs": "/developers/reference/flows/connections#get-api-connections"
  },
  {
   "section": "flows",
   "resource": "connections",
   "method": "GET",
   "path": "/api/connections/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/connections/:id",
   "summary": "Editing form: the non-secret fields, and which secrets are set",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/connections#get-api-connections-id"
  },
  {
   "section": "flows",
   "resource": "connections",
   "method": "POST",
   "path": "/api/connections",
   "url": "https://<your-org>.brambleit.cloud/flows/api/connections",
   "summary": "Create a connection",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "scope",
     "type": "any",
     "required": false
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/connections#post-api-connections"
  },
  {
   "section": "flows",
   "resource": "connections",
   "method": "PUT",
   "path": "/api/connections/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/connections/:id",
   "summary": "Update a connection",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/connections#put-api-connections-id"
  },
  {
   "section": "flows",
   "resource": "connections",
   "method": "DELETE",
   "path": "/api/connections/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/connections/:id",
   "summary": "Delete a connection",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [
    "force"
   ],
   "body": [],
   "docs": "/developers/reference/flows/connections#delete-api-connections-id"
  },
  {
   "section": "flows",
   "resource": "connections",
   "method": "GET",
   "path": "/api/connections/:id/folders",
   "url": "https://<your-org>.brambleit.cloud/flows/api/connections/:id/folders",
   "summary": "A mailbox connection's folders (for the IMAP trigger's folder pickers), if the flow (?flow=) may use the connection",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [
    "flow"
   ],
   "body": [],
   "docs": "/developers/reference/flows/connections#get-api-connections-id-folders"
  },
  {
   "section": "flows",
   "resource": "connections",
   "method": "POST",
   "path": "/api/connections/test",
   "url": "https://<your-org>.brambleit.cloud/flows/api/connections/test",
   "summary": "Test a connection: a saved one (:id, optionally with changed fields) or an unsaved one (body.type + body.data)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "type",
     "type": "string",
     "required": false
    },
    {
     "name": "id",
     "type": "integer",
     "required": false
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/connections#post-api-connections-test"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "GET",
   "path": "/api/flows/:id/export",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/export",
   "summary": "A flow as a file: secrets and webhook tokens blanked; the connections and tables it uses listed by name so an import can match them up",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/flows#get-api-flows-id-export"
  },
  {
   "section": "flows",
   "resource": "templates",
   "method": "GET",
   "path": "/api/templates",
   "url": "https://<your-org>.brambleit.cloud/flows/api/templates",
   "summary": "List templates",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/templates#get-api-templates"
  },
  {
   "section": "flows",
   "resource": "templates",
   "method": "POST",
   "path": "/api/templates",
   "url": "https://<your-org>.brambleit.cloud/flows/api/templates",
   "summary": "Save a flow as a template",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "category",
     "type": "any",
     "required": false
    },
    {
     "name": "share",
     "type": "any",
     "required": false
    },
    {
     "name": "flow_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/templates#post-api-templates"
  },
  {
   "section": "flows",
   "resource": "templates",
   "method": "DELETE",
   "path": "/api/templates/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/templates/:id",
   "summary": "Delete a template",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/templates#delete-api-templates-id"
  },
  {
   "section": "flows",
   "resource": "templates",
   "method": "POST",
   "path": "/api/templates/use",
   "url": "https://<your-org>.brambleit.cloud/flows/api/templates/use",
   "summary": "Create a flow from a template",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "scope",
     "type": "string",
     "required": false
    },
    {
     "name": "source",
     "type": "any",
     "required": false
    },
    {
     "name": "id",
     "type": "integer",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/templates#post-api-templates-use"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "POST",
   "path": "/api/flows/import",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/import",
   "summary": "Body: { data: <a Flows export or an n8n workflow export>, scope?, name?",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "scope",
     "type": "any",
     "required": false
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/flows#post-api-flows-import"
  },
  {
   "section": "flows",
   "resource": "flows",
   "method": "POST",
   "path": "/api/flows/:id/preview",
   "url": "https://<your-org>.brambleit.cloud/flows/api/flows/:id/preview",
   "summary": "What an expression gives, using a run's data for a step (the editor's live preview)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "template",
     "type": "any",
     "required": false
    },
    {
     "name": "runId",
     "type": "number",
     "required": false
    },
    {
     "name": "graph",
     "type": "any",
     "required": false
    },
    {
     "name": "nodeId",
     "type": "any",
     "required": false
    },
    {
     "name": "itemIndex",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/flows#post-api-flows-id-preview"
  },
  {
   "section": "flows",
   "resource": "bramble",
   "method": "GET",
   "path": "/api/devices",
   "url": "https://<your-org>.brambleit.cloud/flows/api/devices",
   "summary": "RMM devices (for the device step)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [
    "flow",
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/flows/bramble#get-api-devices"
  },
  {
   "section": "flows",
   "resource": "waits",
   "method": "GET",
   "path": "/api/actions/:token",
   "url": "https://<your-org>.brambleit.cloud/flows/api/actions/:token",
   "summary": "Open an action link",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/waits#get-api-actions-token"
  },
  {
   "section": "flows",
   "resource": "waits",
   "method": "POST",
   "path": "/api/actions/:token",
   "url": "https://<your-org>.brambleit.cloud/flows/api/actions/:token",
   "summary": "Answer an action link",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/waits#post-api-actions-token"
  },
  {
   "section": "flows",
   "resource": "variables",
   "method": "GET",
   "path": "/api/variables",
   "url": "https://<your-org>.brambleit.cloud/flows/api/variables",
   "summary": "List variables",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/variables#get-api-variables"
  },
  {
   "section": "flows",
   "resource": "variables",
   "method": "POST",
   "path": "/api/variables",
   "url": "https://<your-org>.brambleit.cloud/flows/api/variables",
   "summary": "Create or update a variable",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "id",
     "type": "integer",
     "required": false
    },
    {
     "name": "scope",
     "type": "any",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "value",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/variables#post-api-variables"
  },
  {
   "section": "flows",
   "resource": "variables",
   "method": "DELETE",
   "path": "/api/variables/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/variables/:id",
   "summary": "Delete a variable",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/variables#delete-api-variables-id"
  },
  {
   "section": "flows",
   "resource": "waits",
   "method": "GET",
   "path": "/api/waits",
   "url": "https://<your-org>.brambleit.cloud/flows/api/waits",
   "summary": "Approvals and forms waiting for me",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/waits#get-api-waits"
  },
  {
   "section": "flows",
   "resource": "waits",
   "method": "GET",
   "path": "/api/waits/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/waits/:id",
   "summary": "Get an approval or form",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/waits#get-api-waits-id"
  },
  {
   "section": "flows",
   "resource": "waits",
   "method": "POST",
   "path": "/api/waits/:id/answer",
   "url": "https://<your-org>.brambleit.cloud/flows/api/waits/:id/answer",
   "summary": "Answer an approval or form",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "answers",
     "type": "array of any",
     "required": false
    },
    {
     "name": "approve",
     "type": "boolean",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/waits#post-api-waits-id-answer"
  },
  {
   "section": "flows",
   "resource": "bramble",
   "method": "GET",
   "path": "/api/bramble/form",
   "url": "https://<your-org>.brambleit.cloud/flows/api/bramble/form",
   "summary": "A form's questions, for the \"Form response submitted\" trigger (as the flow's owner: their own access decides)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [
    "flow",
    "form"
   ],
   "body": [],
   "docs": "/developers/reference/flows/bramble#get-api-bramble-form"
  },
  {
   "section": "flows",
   "resource": "bramble",
   "method": "GET",
   "path": "/api/bramble/options",
   "url": "https://<your-org>.brambleit.cloud/flows/api/bramble/options",
   "summary": "Pickers in Bramble steps (engine/nodes/bramble.js OPTION_SOURCES), as the flow's owner: ?flow=&source=psa.queues[&project=12]",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [
    "flow",
    "source",
    "project"
   ],
   "body": [],
   "docs": "/developers/reference/flows/bramble#get-api-bramble-options"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "GET",
   "path": "/api/tables",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables",
   "summary": "List tables",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [
    "flow"
   ],
   "body": [],
   "docs": "/developers/reference/flows/tables#get-api-tables"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "POST",
   "path": "/api/tables",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables",
   "summary": "Create a table",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "scope",
     "type": "any",
     "required": false
    },
    {
     "name": "columns",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/tables#post-api-tables"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "GET",
   "path": "/api/tables/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables/:id",
   "summary": "Get a table and its rows",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [
    "offset",
    "limit",
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/flows/tables#get-api-tables-id"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "PUT",
   "path": "/api/tables/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables/:id",
   "summary": "Update a table's columns",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "columns",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/tables#put-api-tables-id"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "DELETE",
   "path": "/api/tables/:id",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables/:id",
   "summary": "Delete a table",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/tables#delete-api-tables-id"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "POST",
   "path": "/api/tables/:id/rows",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables/:id/rows",
   "summary": "Add a row",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/tables#post-api-tables-id-rows"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "PUT",
   "path": "/api/tables/:id/rows/:rowId",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables/:id/rows/:rowId",
   "summary": "Update a row",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id",
    "rowId"
   ],
   "query": [],
   "body": [
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/tables#put-api-tables-id-rows-rowid"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "DELETE",
   "path": "/api/tables/:id/rows/:rowId",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables/:id/rows/:rowId",
   "summary": "Delete a row",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id",
    "rowId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/tables#delete-api-tables-id-rows-rowid"
  },
  {
   "section": "flows",
   "resource": "tables",
   "method": "DELETE",
   "path": "/api/tables/:id/rows",
   "url": "https://<your-org>.brambleit.cloud/flows/api/tables/:id/rows",
   "summary": "Delete every row",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/tables#delete-api-tables-id-rows"
  },
  {
   "section": "flows",
   "resource": "bramble",
   "method": "POST",
   "path": "/api/events/test",
   "url": "https://<your-org>.brambleit.cloud/flows/api/events/test",
   "summary": "Sends a \"flows.test\" event for the current user, to try event triggers",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "message",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/bramble#post-api-events-test"
  },
  {
   "section": "flows",
   "resource": "bramble",
   "method": "POST",
   "path": "/api/schedule/preview",
   "url": "https://<your-org>.brambleit.cloud/flows/api/schedule/preview",
   "summary": "When a schedule would next run, for the settings panel",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "schedule",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/bramble#post-api-schedule-preview"
  },
  {
   "section": "flows",
   "resource": "bramble",
   "method": "GET",
   "path": "/api/events/:type/sample",
   "url": "https://<your-org>.brambleit.cloud/flows/api/events/:type/sample",
   "summary": "Example data for an app event",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Flows."
   ],
   "params": [
    "type"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/bramble#get-api-events-type-sample"
  },
  {
   "section": "flows",
   "resource": "bramble-bridge",
   "method": "GET",
   "path": "/v1/flows/devices",
   "url": "https://<your-org>.brambleit.cloud/api/v1/flows/devices",
   "summary": "Devices a flow's owner can use",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM.",
    "Permission (any of): `rmm.devices.view`."
   ],
   "params": [],
   "query": [
    "q"
   ],
   "body": [],
   "docs": "/developers/reference/flows/bramble-bridge#get-v1-flows-devices"
  },
  {
   "section": "flows",
   "resource": "bramble-bridge",
   "method": "POST",
   "path": "/v1/flows/devices/:id/run",
   "url": "https://<your-org>.brambleit.cloud/api/v1/flows/devices/:id/run",
   "summary": "Run a script on a device for a flow",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM.",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "language",
     "type": "any",
     "required": false
    },
    {
     "name": "script",
     "type": "any",
     "required": false
    },
    {
     "name": "args",
     "type": "array of any",
     "required": false
    },
    {
     "name": "timeout_seconds",
     "type": "number",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/flows/bramble-bridge#post-v1-flows-devices-id-run"
  },
  {
   "section": "flows",
   "resource": "bramble-bridge",
   "method": "GET",
   "path": "/v1/flows/commands/:id",
   "url": "https://<your-org>.brambleit.cloud/api/v1/flows/commands/:id",
   "summary": "Result of a device script",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`).",
    "Licence: RMM.",
    "Permission (any of): `rmm.scripts.run`."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/flows/bramble-bridge#get-v1-flows-commands-id"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "GET",
   "path": "/api/me",
   "url": "https://<your-org>.brambleit.cloud/paper/api/me",
   "summary": "Who you are: the signed-in person and what they can do here",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/documents#get-api-me"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents",
   "summary": "Search and list documents",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [
    "sort",
    "limit",
    "offset"
   ],
   "body": [],
   "docs": "/developers/reference/paper/documents#get-api-documents"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id",
   "summary": "Get a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/documents#get-api-documents-id"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "PATCH",
   "path": "/api/documents/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id",
   "summary": "Update a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "title",
     "type": "string",
     "required": false
    },
    {
     "name": "date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "correspondent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "doctype_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "notes",
     "type": "string",
     "required": false
    },
    {
     "name": "asn",
     "type": "string",
     "required": false
    },
    {
     "name": "tag_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/documents#patch-api-documents-id"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "DELETE",
   "path": "/api/documents/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id",
   "summary": "Delete a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/documents#delete-api-documents-id"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents/bulk",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/bulk",
   "summary": "Change many documents at once",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "all",
     "type": "any",
     "required": false
    },
    {
     "name": "filters",
     "type": "array of any",
     "required": false
    },
    {
     "name": "ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "op",
     "type": "string",
     "required": false
    },
    {
     "name": "value",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/documents#post-api-documents-bulk"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents/:id/reprocess",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id/reprocess",
   "summary": "Read a document's text again",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/documents#post-api-documents-id-reprocess"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id/file",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id/file",
   "summary": "The file itself, streamed from Drive (Range passed on, for PDF.js)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [
    "original",
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/paper/documents#get-api-documents-id-file"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents/:id/unlock",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id/unlock",
   "summary": "Unlock a password-protected PDF",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "password",
     "type": "any",
     "required": false
    },
    {
     "name": "remember",
     "type": "any",
     "required": false
    },
    {
     "name": "label",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/documents#post-api-documents-id-unlock"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id/thumb",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id/thumb",
   "summary": "A document's thumbnail",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/documents#get-api-documents-id-thumb"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id/sharing",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id/sharing",
   "summary": "Sharing is Drive's: links (with expiry, password, download switch) and people/groups",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/documents#get-api-documents-id-sharing"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents/:id/links",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id/links",
   "summary": "Create a share link",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "expires_days",
     "type": "integer",
     "required": false
    },
    {
     "name": "password",
     "type": "any",
     "required": false
    },
    {
     "name": "allow_download",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/documents#post-api-documents-id-links"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "DELETE",
   "path": "/api/documents/:id/links/:lid",
   "url": "https://<your-org>.brambleit.cloud/paper/api/documents/:id/links/:lid",
   "summary": "Delete a share link",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id",
    "lid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/documents#delete-api-documents-id-links-lid"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "POST",
   "path": "/api/upload",
   "url": "https://<your-org>.brambleit.cloud/paper/api/upload",
   "summary": "Add a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [
    "cabinet",
    "name"
   ],
   "body": [],
   "docs": "/developers/reference/paper/documents#post-api-upload"
  },
  {
   "section": "paper",
   "resource": "cabinets",
   "method": "GET",
   "path": "/api/cabinets",
   "url": "https://<your-org>.brambleit.cloud/paper/api/cabinets",
   "summary": "List cabinets",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/cabinets#get-api-cabinets"
  },
  {
   "section": "paper",
   "resource": "cabinets",
   "method": "GET",
   "path": "/api/cabinets/libraries",
   "url": "https://<your-org>.brambleit.cloud/paper/api/cabinets/libraries",
   "summary": "Drive libraries that could become cabinets",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/cabinets#get-api-cabinets-libraries"
  },
  {
   "section": "paper",
   "resource": "cabinets",
   "method": "POST",
   "path": "/api/cabinets",
   "url": "https://<your-org>.brambleit.cloud/paper/api/cabinets",
   "summary": "Make a library a cabinet",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "library_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/cabinets#post-api-cabinets"
  },
  {
   "section": "paper",
   "resource": "cabinets",
   "method": "PATCH",
   "path": "/api/cabinets/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/cabinets/:id",
   "summary": "Update a cabinet",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "path_template",
     "type": "any",
     "required": false
    },
    {
     "name": "watch_drive",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/cabinets#patch-api-cabinets-id"
  },
  {
   "section": "paper",
   "resource": "cabinets",
   "method": "DELETE",
   "path": "/api/cabinets/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/cabinets/:id",
   "summary": "Stop using a library as a cabinet",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/cabinets#delete-api-cabinets-id"
  },
  {
   "section": "paper",
   "resource": "cabinets",
   "method": "GET",
   "path": "/api/cabinets/:id/passwords",
   "url": "https://<your-org>.brambleit.cloud/paper/api/cabinets/:id/passwords",
   "summary": "Saved passwords for locked PDFs (labels only — never the passwords back)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/cabinets#get-api-cabinets-id-passwords"
  },
  {
   "section": "paper",
   "resource": "cabinets",
   "method": "POST",
   "path": "/api/cabinets/:id/passwords",
   "url": "https://<your-org>.brambleit.cloud/paper/api/cabinets/:id/passwords",
   "summary": "Save a password for locked PDFs",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "password",
     "type": "any",
     "required": false
    },
    {
     "name": "label",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/cabinets#post-api-cabinets-id-passwords"
  },
  {
   "section": "paper",
   "resource": "cabinets",
   "method": "DELETE",
   "path": "/api/cabinets/:id/passwords/:pid",
   "url": "https://<your-org>.brambleit.cloud/paper/api/cabinets/:id/passwords/:pid",
   "summary": "Delete a saved password",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id",
    "pid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/cabinets#delete-api-cabinets-id-passwords-pid"
  },
  {
   "section": "paper",
   "resource": "labels",
   "method": "GET",
   "path": "/api/labels/:kind",
   "url": "https://<your-org>.brambleit.cloud/paper/api/labels/:kind",
   "summary": "List labels",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "kind"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/labels#get-api-labels-kind"
  },
  {
   "section": "paper",
   "resource": "labels",
   "method": "POST",
   "path": "/api/labels/:kind",
   "url": "https://<your-org>.brambleit.cloud/paper/api/labels/:kind",
   "summary": "Create a label",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "kind"
   ],
   "query": [],
   "body": [
    {
     "name": "cabinet_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/labels#post-api-labels-kind"
  },
  {
   "section": "paper",
   "resource": "labels",
   "method": "PATCH",
   "path": "/api/labels/:kind/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/labels/:kind/:id",
   "summary": "Update a label",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "kind",
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "cabinet_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/labels#patch-api-labels-kind-id"
  },
  {
   "section": "paper",
   "resource": "labels",
   "method": "DELETE",
   "path": "/api/labels/:kind/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/labels/:kind/:id",
   "summary": "Delete a label",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "kind",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/labels#delete-api-labels-kind-id"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "POST",
   "path": "/api/views",
   "url": "https://<your-org>.brambleit.cloud/paper/api/views",
   "summary": "Save a view (filters)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "filters",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/documents#post-api-views"
  },
  {
   "section": "paper",
   "resource": "documents",
   "method": "DELETE",
   "path": "/api/views/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/views/:id",
   "summary": "Delete a saved view",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/documents#delete-api-views-id"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "GET",
   "path": "/api/mail",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail",
   "summary": "Mail accounts and rules",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/mail#get-api-mail"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "POST",
   "path": "/api/mail/accounts",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail/accounts",
   "summary": "Add a mailbox to check",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "port",
     "type": "number",
     "required": false
    },
    {
     "name": "secure",
     "type": "any",
     "required": false
    },
    {
     "name": "allow_self_signed",
     "type": "any",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "password",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/mail#post-api-mail-accounts"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "PATCH",
   "path": "/api/mail/accounts/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail/accounts/:id",
   "summary": "Update a mailbox",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "port",
     "type": "number",
     "required": false
    },
    {
     "name": "secure",
     "type": "any",
     "required": false
    },
    {
     "name": "allow_self_signed",
     "type": "any",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "password",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/mail#patch-api-mail-accounts-id"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "DELETE",
   "path": "/api/mail/accounts/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail/accounts/:id",
   "summary": "Remove a mailbox",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/mail#delete-api-mail-accounts-id"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "POST",
   "path": "/api/mail/accounts/:id/test",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail/accounts/:id/test",
   "summary": "Signs in and returns the folders",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/mail#post-api-mail-accounts-id-test"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "POST",
   "path": "/api/mail/accounts/:id/check",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail/accounts/:id/check",
   "summary": "Check a mailbox now",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/mail#post-api-mail-accounts-id-check"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "POST",
   "path": "/api/mail/rules",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail/rules",
   "summary": "Create a mail rule",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "account_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/mail#post-api-mail-rules"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "PATCH",
   "path": "/api/mail/rules/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail/rules/:id",
   "summary": "Update a mail rule",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "cabinet_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "enabled",
     "type": "boolean",
     "required": false
    },
    {
     "name": "sort",
     "type": "number",
     "required": false
    },
    {
     "name": "max_age_days",
     "type": "number",
     "required": false
    },
    {
     "name": "title_from",
     "type": "string",
     "required": false
    },
    {
     "name": "correspondent_mode",
     "type": "string: \"match\" \\| \"sender\" \\| \"set\"",
     "required": false
    },
    {
     "name": "action",
     "type": "string: \"read\" \\| \"flag\" \\| \"move\" \\| \"delete\" \\| \"none\"",
     "required": false
    },
    {
     "name": "tag_ids",
     "type": "array of any",
     "required": false
    },
    {
     "name": "correspondent_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "doctype_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "action_folder",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/paper/mail#patch-api-mail-rules-id"
  },
  {
   "section": "paper",
   "resource": "mail",
   "method": "DELETE",
   "path": "/api/mail/rules/:id",
   "url": "https://<your-org>.brambleit.cloud/paper/api/mail/rules/:id",
   "summary": "Delete a mail rule",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Paper."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/mail#delete-api-mail-rules-id"
  },
  {
   "section": "paper",
   "resource": "share",
   "method": "POST",
   "path": "/share",
   "url": "https://<your-org>.brambleit.cloud/paper/share",
   "summary": "\"Share to Paper\" from a phone lands here only if the service worker (which normally takes the files) isn't installed yet: just open the app",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/paper/share#post-share"
  },
  {
   "section": "atlas",
   "resource": "admin",
   "method": "GET",
   "path": "/api/admin/overview",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/admin/overview",
   "summary": "Atlas admin overview",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/admin#get-api-admin-overview"
  },
  {
   "section": "atlas",
   "resource": "admin",
   "method": "POST",
   "path": "/api/admin/types",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/admin/types",
   "summary": "Create an asset type",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "category",
     "type": "string",
     "required": false
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    },
    {
     "name": "colour",
     "type": "any",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "fields",
     "type": "array of any",
     "required": false
    },
    {
     "name": "sort",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/admin#post-api-admin-types"
  },
  {
   "section": "atlas",
   "resource": "admin",
   "method": "PUT",
   "path": "/api/admin/types/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/admin/types/:id",
   "summary": "Update an asset type",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "fields",
     "type": "array of any",
     "required": false
    },
    {
     "name": "archived",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/admin#put-api-admin-types-id"
  },
  {
   "section": "atlas",
   "resource": "admin",
   "method": "PUT",
   "path": "/api/admin/settings",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/admin/settings",
   "summary": "Update Atlas settings",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "warn_days",
     "type": "number",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/admin#put-api-admin-settings"
  },
  {
   "section": "atlas",
   "resource": "admin",
   "method": "GET",
   "path": "/api/admin/storage",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/admin/storage",
   "summary": "What Atlas keeps in BRM-Blob: Blob's own figures for app \"atlas\" (used, any Atlas limit, the tenant pool) plus a breakdown from the files table by kind and o…",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/admin#get-api-admin-storage"
  },
  {
   "section": "atlas",
   "resource": "admin",
   "method": "POST",
   "path": "/api/admin/storage/free",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/admin/storage/free",
   "summary": "Deletes the files counted in \"spare\": attachments of records deleted more than 30 days ago, and document images that were never saved into a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/admin#post-api-admin-storage-free"
  },
  {
   "section": "atlas",
   "resource": "home",
   "method": "GET",
   "path": "/api/me",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/me",
   "summary": "Who you are: the signed-in person and what they can do here",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/home#get-api-me"
  },
  {
   "section": "atlas",
   "resource": "home",
   "method": "GET",
   "path": "/api/home",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/home",
   "summary": "Home page summary",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/home#get-api-home"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs",
   "summary": "List organisations",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs",
   "summary": "Create an organisation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "short_name",
     "type": "string",
     "required": false
    },
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "website",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "string",
     "required": false
    },
    {
     "name": "address",
     "type": "string",
     "required": false
    },
    {
     "name": "notes",
     "type": "string",
     "required": false
    },
    {
     "name": "alert_note",
     "type": "string",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "org_type",
     "type": "string",
     "required": false
    },
    {
     "name": "account_manager_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "primary_contact_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id",
   "summary": "Get an organisation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/logo",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/logo",
   "summary": "The organisation's logo: a PNG/JPEG/WebP (the page scales it to 256 px first), kept as an Atlas file in Blob",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-logo"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "DELETE",
   "path": "/api/orgs/:id/logo",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/logo",
   "summary": "Remove an organisation's logo",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#delete-api-orgs-id-logo"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "PUT",
   "path": "/api/orgs/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id",
   "summary": "Update an organisation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#put-api-orgs-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/overview",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/overview",
   "summary": "The organisation's one-page summary: open tickets, devices, what's running out, what changed, pinned documents",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-overview"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/activity",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/activity",
   "summary": "An organisation's recent activity",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [
    "before"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-activity"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/contacts",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/contacts",
   "summary": "An organisation's contacts",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-contacts"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/contacts",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/contacts",
   "summary": "Add a contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "first_name",
     "type": "string",
     "required": false
    },
    {
     "name": "last_name",
     "type": "string",
     "required": false
    },
    {
     "name": "email",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "string",
     "required": false
    },
    {
     "name": "mobile",
     "type": "string",
     "required": false
    },
    {
     "name": "job_title",
     "type": "string",
     "required": false
    },
    {
     "name": "contact_type",
     "type": "string",
     "required": false
    },
    {
     "name": "location_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "is_important",
     "type": "boolean",
     "required": false
    },
    {
     "name": "notes",
     "type": "string",
     "required": false
    },
    {
     "name": "primary",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-contacts"
  },
  {
   "section": "atlas",
   "resource": "contacts",
   "method": "GET",
   "path": "/api/contacts/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/contacts/:id",
   "summary": "Get a contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/contacts#get-api-contacts-id"
  },
  {
   "section": "atlas",
   "resource": "contacts",
   "method": "PUT",
   "path": "/api/contacts/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/contacts/:id",
   "summary": "Update a contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "primary",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/contacts#put-api-contacts-id"
  },
  {
   "section": "atlas",
   "resource": "contacts",
   "method": "DELETE",
   "path": "/api/contacts/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/contacts/:id",
   "summary": "Delete a contact",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/contacts#delete-api-contacts-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/locations",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/locations",
   "summary": "An organisation's locations",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-locations"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/locations",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/locations",
   "summary": "Add a location",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "address1",
     "type": "string",
     "required": false
    },
    {
     "name": "address2",
     "type": "string",
     "required": false
    },
    {
     "name": "city",
     "type": "string",
     "required": false
    },
    {
     "name": "region",
     "type": "string",
     "required": false
    },
    {
     "name": "postcode",
     "type": "string",
     "required": false
    },
    {
     "name": "country",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "string",
     "required": false
    },
    {
     "name": "is_primary",
     "type": "boolean",
     "required": false
    },
    {
     "name": "notes",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-locations"
  },
  {
   "section": "atlas",
   "resource": "contacts",
   "method": "PUT",
   "path": "/api/locations/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/locations/:id",
   "summary": "Update a location",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/contacts#put-api-locations-id"
  },
  {
   "section": "atlas",
   "resource": "contacts",
   "method": "DELETE",
   "path": "/api/locations/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/locations/:id",
   "summary": "Delete a location",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/contacts#delete-api-locations-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/rmm",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/rmm",
   "summary": "The organisation's RMM sites and devices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-rmm"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/rmm/link-site",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/rmm/link-site",
   "summary": "Link an RMM site to the organisation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-rmm-link-site"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/rmm/unlink-site",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/rmm/unlink-site",
   "summary": "Unlink an RMM site",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "site_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-rmm-unlink-site"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/rmm/import",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/rmm/import",
   "summary": "Import RMM devices as configurations",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "device_ids",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-rmm-import"
  },
  {
   "section": "atlas",
   "resource": "home",
   "method": "GET",
   "path": "/api/search",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/search",
   "summary": "Search Atlas",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [
    "q",
    "org"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/home#get-api-search"
  },
  {
   "section": "atlas",
   "resource": "home",
   "method": "GET",
   "path": "/api/expiries",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/expiries",
   "summary": "Things expiring soon",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [
    "days",
    "org"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/home#get-api-expiries"
  },
  {
   "section": "atlas",
   "resource": "home",
   "method": "GET",
   "path": "/api/users",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/users",
   "summary": "People in the tenant (account manager pickers)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/home#get-api-users"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/assets",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/assets",
   "summary": "An organisation's assets",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [
    "type",
    "category"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-assets"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "GET",
   "path": "/api/assets/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/assets/:id",
   "summary": "Get an asset",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/assets#get-api-assets-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/assets",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/assets",
   "summary": "Add an asset",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "status",
     "type": "string",
     "required": false
    },
    {
     "name": "location_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "contact_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "notes",
     "type": "array of any",
     "required": false
    },
    {
     "name": "hostname",
     "type": "string",
     "required": false
    },
    {
     "name": "ip",
     "type": "string",
     "required": false
    },
    {
     "name": "mac",
     "type": "string",
     "required": false
    },
    {
     "name": "serial",
     "type": "string",
     "required": false
    },
    {
     "name": "manufacturer",
     "type": "string",
     "required": false
    },
    {
     "name": "model",
     "type": "string",
     "required": false
    },
    {
     "name": "os",
     "type": "string",
     "required": false
    },
    {
     "name": "purchased_on",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "warranty_expires",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "type_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-assets"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "PUT",
   "path": "/api/assets/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/assets/:id",
   "summary": "Update an asset",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "data",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/assets#put-api-assets-id"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "POST",
   "path": "/api/assets/:id/reveal",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/assets/:id/reveal",
   "summary": "Reveal a secret field",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "key",
     "type": "string",
     "required": false
    },
    {
     "name": "copy",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/assets#post-api-assets-id-reveal"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "DELETE",
   "path": "/api/assets/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/assets/:id",
   "summary": "Delete an asset",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/assets#delete-api-assets-id"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "POST",
   "path": "/api/assets/:id/rmm-sync",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/assets/:id/rmm-sync",
   "summary": "Update an asset from its RMM device",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/assets#post-api-assets-id-rmm-sync"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "POST",
   "path": "/api/assets/:id/rmm-link",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/assets/:id/rmm-link",
   "summary": "Link an asset to an RMM device",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "device_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/assets#post-api-assets-id-rmm-link"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "GET",
   "path": "/api/relations",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/relations",
   "summary": "What a record is related to",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [
    "kind",
    "id"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/assets#get-api-relations"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "POST",
   "path": "/api/relations",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/relations",
   "summary": "Relate two records",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "a_kind",
     "type": "string",
     "required": false
    },
    {
     "name": "b_kind",
     "type": "string",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    },
    {
     "name": "a_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "b_id",
     "type": "integer",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/assets#post-api-relations"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "DELETE",
   "path": "/api/relations/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/relations/:id",
   "summary": "Remove a relation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/assets#delete-api-relations-id"
  },
  {
   "section": "atlas",
   "resource": "files",
   "method": "GET",
   "path": "/api/files",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/files",
   "summary": "Files on a record",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [
    "kind",
    "id"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/files#get-api-files"
  },
  {
   "section": "atlas",
   "resource": "files",
   "method": "POST",
   "path": "/api/files",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/files",
   "summary": "Attach a file",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [
    "kind",
    "id",
    "name"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/files#post-api-files"
  },
  {
   "section": "atlas",
   "resource": "files",
   "method": "GET",
   "path": "/api/files/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/files/:id",
   "summary": "Download a file",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/files#get-api-files-id"
  },
  {
   "section": "atlas",
   "resource": "files",
   "method": "DELETE",
   "path": "/api/files/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/files/:id",
   "summary": "Delete a file",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/files#delete-api-files-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/passwords",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/passwords",
   "summary": "An organisation's passwords",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-passwords"
  },
  {
   "section": "atlas",
   "resource": "passwords",
   "method": "GET",
   "path": "/api/passwords",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/passwords",
   "summary": "Passwords that belong to no organisation: the MSP's own (distributors, vendor portals...)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [
    "asset"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/passwords#get-api-passwords"
  },
  {
   "section": "atlas",
   "resource": "passwords",
   "method": "GET",
   "path": "/api/passwords/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/passwords/:id",
   "summary": "Get a password's details (not its value)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/passwords#get-api-passwords-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/passwords",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/passwords",
   "summary": "Add a password to an organisation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-passwords"
  },
  {
   "section": "atlas",
   "resource": "passwords",
   "method": "POST",
   "path": "/api/passwords",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/passwords",
   "summary": "Add a password with no organisation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/passwords#post-api-passwords"
  },
  {
   "section": "atlas",
   "resource": "passwords",
   "method": "PUT",
   "path": "/api/passwords/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/passwords/:id",
   "summary": "Update a password",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "restricted",
     "type": "boolean",
     "required": false
    },
    {
     "name": "password",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/passwords#put-api-passwords-id"
  },
  {
   "section": "atlas",
   "resource": "passwords",
   "method": "DELETE",
   "path": "/api/passwords/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/passwords/:id",
   "summary": "Delete a password",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/passwords#delete-api-passwords-id"
  },
  {
   "section": "atlas",
   "resource": "passwords",
   "method": "POST",
   "path": "/api/passwords/:id/reveal",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/passwords/:id/reveal",
   "summary": "Reveal a password",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "what",
     "type": "string",
     "required": false
    },
    {
     "name": "copy",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/passwords#post-api-passwords-id-reveal"
  },
  {
   "section": "atlas",
   "resource": "passwords",
   "method": "POST",
   "path": "/api/passwords/:id/totp",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/passwords/:id/totp",
   "summary": "Current TOTP code for a password",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/passwords#post-api-passwords-id-totp"
  },
  {
   "section": "atlas",
   "resource": "home",
   "method": "GET",
   "path": "/api/generate",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/generate",
   "summary": "Generate a strong password",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [
    "length",
    "k"
   ],
   "body": [],
   "docs": "/developers/reference/atlas/home#get-api-generate"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/documents",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/documents",
   "summary": "An organisation's documents",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-documents"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents",
   "summary": "Library documents",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/documents#get-api-documents"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents/:id",
   "summary": "Get a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/documents#get-api-documents-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/documents",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/documents",
   "summary": "Add a document to an organisation",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-documents"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents",
   "summary": "Add a library document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/documents#post-api-documents"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "PUT",
   "path": "/api/documents/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents/:id",
   "summary": "Save a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "base_updated_at",
     "type": "string (date-time)",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/documents#put-api-documents-id"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "DELETE",
   "path": "/api/documents/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents/:id",
   "summary": "Archive a document",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/documents#delete-api-documents-id"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id/versions",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents/:id/versions",
   "summary": "A document's versions",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/documents#get-api-documents-id-versions"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "GET",
   "path": "/api/documents/:id/versions/:vid",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents/:id/versions/:vid",
   "summary": "Get a document version",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id",
    "vid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/documents#get-api-documents-id-versions-vid"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents/:id/versions/:vid/restore",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents/:id/versions/:vid/restore",
   "summary": "Restore a document version",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id",
    "vid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/documents#post-api-documents-id-versions-vid-restore"
  },
  {
   "section": "atlas",
   "resource": "documents",
   "method": "POST",
   "path": "/api/documents/:id/copy",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/documents/:id/copy",
   "summary": "Copy a library document (e.g",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "org",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/documents#post-api-documents-id-copy"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/domains",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/domains",
   "summary": "An organisation's domains",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-domains"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/domains",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/domains",
   "summary": "Add a domain",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-domains"
  },
  {
   "section": "atlas",
   "resource": "domains",
   "method": "PUT",
   "path": "/api/domains/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/domains/:id",
   "summary": "Update a domain",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/domains#put-api-domains-id"
  },
  {
   "section": "atlas",
   "resource": "domains",
   "method": "POST",
   "path": "/api/domains/:id/check",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/domains/:id/check",
   "summary": "Check a domain and its certificate now",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/domains#post-api-domains-id-check"
  },
  {
   "section": "atlas",
   "resource": "domains",
   "method": "DELETE",
   "path": "/api/domains/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/domains/:id",
   "summary": "Delete a domain",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/domains#delete-api-domains-id"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/diagrams",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/diagrams",
   "summary": "An organisation's diagrams",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-diagrams"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/diagrams",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/diagrams",
   "summary": "Create a diagram",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "kind",
     "type": "string",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "location_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "thumb",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-diagrams"
  },
  {
   "section": "atlas",
   "resource": "diagrams",
   "method": "GET",
   "path": "/api/diagrams/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/diagrams/:id",
   "summary": "Get a diagram",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/diagrams#get-api-diagrams-id"
  },
  {
   "section": "atlas",
   "resource": "diagrams",
   "method": "PUT",
   "path": "/api/diagrams/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/diagrams/:id",
   "summary": "Save a diagram",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "base_version",
     "type": "number",
     "required": false
    },
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "location_id",
     "type": "integer",
     "required": false
    },
    {
     "name": "pinned",
     "type": "boolean",
     "required": false
    },
    {
     "name": "thumb",
     "type": "any",
     "required": false
    },
    {
     "name": "data",
     "type": "any",
     "required": false
    },
    {
     "name": "checkpoint",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/diagrams#put-api-diagrams-id"
  },
  {
   "section": "atlas",
   "resource": "diagrams",
   "method": "DELETE",
   "path": "/api/diagrams/:id",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/diagrams/:id",
   "summary": "Archive a diagram",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/diagrams#delete-api-diagrams-id"
  },
  {
   "section": "atlas",
   "resource": "diagrams",
   "method": "POST",
   "path": "/api/diagrams/:id/duplicate",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/diagrams/:id/duplicate",
   "summary": "Copy a diagram",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/diagrams#post-api-diagrams-id-duplicate"
  },
  {
   "section": "atlas",
   "resource": "diagrams",
   "method": "GET",
   "path": "/api/diagrams/:id/versions",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/diagrams/:id/versions",
   "summary": "A diagram's versions",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/diagrams#get-api-diagrams-id-versions"
  },
  {
   "section": "atlas",
   "resource": "diagrams",
   "method": "GET",
   "path": "/api/diagrams/:id/versions/:vid",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/diagrams/:id/versions/:vid",
   "summary": "Get a diagram version",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id",
    "vid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/diagrams#get-api-diagrams-id-versions-vid"
  },
  {
   "section": "atlas",
   "resource": "diagrams",
   "method": "POST",
   "path": "/api/diagrams/:id/versions/:vid/restore",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/diagrams/:id/versions/:vid/restore",
   "summary": "Restore a diagram version",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id",
    "vid"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/diagrams#post-api-diagrams-id-versions-vid-restore"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/diagram-sources",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/diagram-sources",
   "summary": "Everything the editor's side panels and live overlay need",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-diagram-sources"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "GET",
   "path": "/api/orgs/:id/diagram-status",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/diagram-status",
   "summary": "Live state of the assets on a diagram (polled by the editor)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/orgs#get-api-orgs-id-diagram-status"
  },
  {
   "section": "atlas",
   "resource": "orgs",
   "method": "POST",
   "path": "/api/orgs/:id/diagrams/generate",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/orgs/:id/diagrams/generate",
   "summary": "Draw a diagram from network data",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "clients",
     "type": "boolean",
     "required": false
    },
    {
     "name": "discovered",
     "type": "boolean",
     "required": false
    },
    {
     "name": "guess",
     "type": "boolean",
     "required": false
    }
   ],
   "docs": "/developers/reference/atlas/orgs#post-api-orgs-id-diagrams-generate"
  },
  {
   "section": "atlas",
   "resource": "assets",
   "method": "GET",
   "path": "/api/assets/:id/diagrams",
   "url": "https://<your-org>.brambleit.cloud/atlas/api/assets/:id/diagrams",
   "summary": "Diagrams an asset appears on (asset page)",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: Atlas."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/atlas/assets#get-api-assets-id-diagrams"
  },
  {
   "section": "simplebooks",
   "resource": "companies",
   "method": "GET",
   "path": "/api/me",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/me",
   "summary": "Who you are: the signed-in person and what they can do here",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/companies#get-api-me"
  },
  {
   "section": "simplebooks",
   "resource": "companies",
   "method": "GET",
   "path": "/api/companies/:companyId",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId",
   "summary": "Get a company",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/companies#get-api-companies-companyid"
  },
  {
   "section": "simplebooks",
   "resource": "companies",
   "method": "PUT",
   "path": "/api/companies/:companyId",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId",
   "summary": "Update a company",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "k",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/companies#put-api-companies-companyid"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "POST",
   "path": "/api/companies/:companyId/categories",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/categories",
   "summary": "Add a category",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "tax_key",
     "type": "string",
     "required": false
    },
    {
     "name": "icon",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/receipts#post-api-companies-companyid-categories"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "PATCH",
   "path": "/api/companies/:companyId/categories/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/categories/:id",
   "summary": "Update a category",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "tax_key",
     "type": "string",
     "required": false
    },
    {
     "name": "archived",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/receipts#patch-api-companies-companyid-categories-id"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "GET",
   "path": "/api/companies/:companyId/receipts",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts",
   "summary": "List receipts",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "deleted",
    "tax_year",
    "month",
    "status",
    "category_id",
    "q",
    "limit",
    "offset"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/receipts#get-api-companies-companyid-receipts"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "POST",
   "path": "/api/companies/:companyId/receipts",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts",
   "summary": "Add a receipt",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "client_ref",
     "type": "any",
     "required": false
    },
    {
     "name": "source",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/receipts#post-api-companies-companyid-receipts"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "GET",
   "path": "/api/companies/:companyId/receipts/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id",
   "summary": "Get a receipt",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/receipts#get-api-companies-companyid-receipts-id"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "PATCH",
   "path": "/api/companies/:companyId/receipts/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id",
   "summary": "Update a receipt",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "merchant",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "notes",
     "type": "string",
     "required": false
    },
    {
     "name": "payment_method",
     "type": "any",
     "required": false
    },
    {
     "name": "receipt_date",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "business_pct",
     "type": "number",
     "required": false
    },
    {
     "name": "category_id",
     "type": "string",
     "required": false
    },
    {
     "name": "confirm",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/receipts#patch-api-companies-companyid-receipts-id"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "DELETE",
   "path": "/api/companies/:companyId/receipts/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id",
   "summary": "Move a receipt to the bin",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/receipts#delete-api-companies-companyid-receipts-id"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "POST",
   "path": "/api/companies/:companyId/receipts/:id/restore",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id/restore",
   "summary": "Restore a receipt from the bin",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/receipts#post-api-companies-companyid-receipts-id-restore"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "POST",
   "path": "/api/companies/:companyId/receipts/:id/reprocess",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id/reprocess",
   "summary": "Read a receipt again",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/receipts#post-api-companies-companyid-receipts-id-reprocess"
  },
  {
   "section": "simplebooks",
   "resource": "receipts",
   "method": "GET",
   "path": "/api/companies/:companyId/receipts/:id/file/:kind",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id/file/:kind",
   "summary": "Decrypted file. Only ever served from here — authenticated and checked against the user's access to this receipt",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id",
    "kind"
   ],
   "query": [
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/receipts#get-api-companies-companyid-receipts-id-file-kind"
  },
  {
   "section": "simplebooks",
   "resource": "companies",
   "method": "GET",
   "path": "/api/companies/:companyId/tax-years",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/tax-years",
   "summary": "Tax years with data",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/companies#get-api-companies-companyid-tax-years"
  },
  {
   "section": "simplebooks",
   "resource": "companies",
   "method": "GET",
   "path": "/api/companies/:companyId/summary",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/summary",
   "summary": "A tax year's figures",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "tax_year"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/companies#get-api-companies-companyid-summary"
  },
  {
   "section": "simplebooks",
   "resource": "export",
   "method": "GET",
   "path": "/api/companies/:companyId/export.csv",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/export.csv",
   "summary": "One tax year as a spreadsheet — same columns as the CSV inside the ZIP",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "tax_year"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/export#get-api-companies-companyid-export-csv"
  },
  {
   "section": "simplebooks",
   "resource": "exports",
   "method": "POST",
   "path": "/api/companies/:companyId/exports",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/exports",
   "summary": "Start a zip export",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "tax_years",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/exports#post-api-companies-companyid-exports"
  },
  {
   "section": "simplebooks",
   "resource": "exports",
   "method": "GET",
   "path": "/api/companies/:companyId/exports/:exportId",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/exports/:exportId",
   "summary": "An export's progress",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "exportId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/exports#get-api-companies-companyid-exports-exportid"
  },
  {
   "section": "simplebooks",
   "resource": "exports",
   "method": "GET",
   "path": "/api/companies/:companyId/exports/:exportId/download",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/exports/:exportId/download",
   "summary": "Download an export",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "exportId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/exports#get-api-companies-companyid-exports-exportid-download"
  },
  {
   "section": "simplebooks",
   "resource": "companies",
   "method": "GET",
   "path": "/api/companies/:companyId/activity",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/activity",
   "summary": "Recent activity",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "limit"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/companies#get-api-companies-companyid-activity"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "GET",
   "path": "/api/companies/:companyId/customers",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/customers",
   "summary": "List customers",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "archived"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#get-api-companies-companyid-customers"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "POST",
   "path": "/api/companies/:companyId/customers",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/customers",
   "summary": "Add a customer",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "contacts",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/invoices#post-api-companies-companyid-customers"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "PUT",
   "path": "/api/companies/:companyId/customers/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/customers/:id",
   "summary": "Update a customer",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "name",
     "type": "string",
     "required": false
    },
    {
     "name": "email",
     "type": "string",
     "required": false
    },
    {
     "name": "phone",
     "type": "string",
     "required": false
    },
    {
     "name": "address",
     "type": "string",
     "required": false
    },
    {
     "name": "notes",
     "type": "string",
     "required": false
    },
    {
     "name": "cis_rate",
     "type": "any",
     "required": false
    },
    {
     "name": "terms_days",
     "type": "string",
     "required": false
    },
    {
     "name": "archived",
     "type": "any",
     "required": false
    },
    {
     "name": "contacts",
     "type": "array of any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/invoices#put-api-companies-companyid-customers-id"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "GET",
   "path": "/api/companies/:companyId/invoice-settings",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoice-settings",
   "summary": "Invoice settings",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#get-api-companies-companyid-invoice-settings"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "PUT",
   "path": "/api/companies/:companyId/invoice-settings",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoice-settings",
   "summary": "Update invoice settings",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "invoice_prefix",
     "type": "any",
     "required": false
    },
    {
     "name": "next_invoice_no",
     "type": "number",
     "required": false
    },
    {
     "name": "default_terms_days",
     "type": "number",
     "required": false
    },
    {
     "name": "bank_account_name",
     "type": "string",
     "required": false
    },
    {
     "name": "bank_sort_code",
     "type": "any",
     "required": false
    },
    {
     "name": "bank_account_no",
     "type": "any",
     "required": false
    },
    {
     "name": "invoice_footer",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/invoices#put-api-companies-companyid-invoice-settings"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "GET",
   "path": "/api/companies/:companyId/invoices",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices",
   "summary": "List invoices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "status",
    "customer_id",
    "tax_year",
    "q",
    "limit",
    "offset"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#get-api-companies-companyid-invoices"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "GET",
   "path": "/api/companies/:companyId/invoices/summary",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/summary",
   "summary": "Money owed right now, plus this tax year's invoicing — for Home and Tax year",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "tax_year"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#get-api-companies-companyid-invoices-summary"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "POST",
   "path": "/api/companies/:companyId/invoices",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices",
   "summary": "Create an invoice",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#post-api-companies-companyid-invoices"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "GET",
   "path": "/api/companies/:companyId/invoices/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id",
   "summary": "Get an invoice",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#get-api-companies-companyid-invoices-id"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "PUT",
   "path": "/api/companies/:companyId/invoices/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id",
   "summary": "Update an invoice",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#put-api-companies-companyid-invoices-id"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "POST",
   "path": "/api/companies/:companyId/invoices/:id/duplicate",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id/duplicate",
   "summary": "Copy an invoice",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#post-api-companies-companyid-invoices-id-duplicate"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "DELETE",
   "path": "/api/companies/:companyId/invoices/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id",
   "summary": "Delete a draft invoice",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#delete-api-companies-companyid-invoices-id"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "POST",
   "path": "/api/companies/:companyId/invoices/:id/void",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id/void",
   "summary": "Void an invoice",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#post-api-companies-companyid-invoices-id-void"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "POST",
   "path": "/api/companies/:companyId/invoices/:id/send",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id/send",
   "summary": "Send an invoice",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "channel",
     "type": "string",
     "required": false
    },
    {
     "name": "to",
     "type": "any",
     "required": false
    },
    {
     "name": "cc",
     "type": "any",
     "required": false
    },
    {
     "name": "message",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/invoices#post-api-companies-companyid-invoices-id-send"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "GET",
   "path": "/api/companies/:companyId/invoices/:id/pdf",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id/pdf",
   "summary": "An invoice as PDF",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#get-api-companies-companyid-invoices-id-pdf"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "POST",
   "path": "/api/companies/:companyId/invoices/:id/payments",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id/payments",
   "summary": "Record a payment",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "paid_on",
     "type": "any",
     "required": false
    },
    {
     "name": "amount",
     "type": "any",
     "required": false
    },
    {
     "name": "method",
     "type": "string",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/invoices#post-api-companies-companyid-invoices-id-payments"
  },
  {
   "section": "simplebooks",
   "resource": "invoices",
   "method": "DELETE",
   "path": "/api/companies/:companyId/invoices/:id/payments/:paymentId",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/:id/payments/:paymentId",
   "summary": "Remove a payment",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id",
    "paymentId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/invoices#delete-api-companies-companyid-invoices-id-payments-paymentid"
  },
  {
   "section": "simplebooks",
   "resource": "income",
   "method": "GET",
   "path": "/api/companies/:companyId/income",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/income",
   "summary": "List income",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "tax_year"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/income#get-api-companies-companyid-income"
  },
  {
   "section": "simplebooks",
   "resource": "income",
   "method": "GET",
   "path": "/api/companies/:companyId/income/summary",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/income/summary",
   "summary": "Income received in a tax year (cash basis): invoice payments + the log",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "tax_year"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/income#get-api-companies-companyid-income-summary"
  },
  {
   "section": "simplebooks",
   "resource": "income",
   "method": "POST",
   "path": "/api/companies/:companyId/income",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/income",
   "summary": "Record income",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/income#post-api-companies-companyid-income"
  },
  {
   "section": "simplebooks",
   "resource": "income",
   "method": "PUT",
   "path": "/api/companies/:companyId/income/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/income/:id",
   "summary": "Update income",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [
    {
     "name": "received_on",
     "type": "string (date)",
     "required": false
    },
    {
     "name": "customer_id",
     "type": "number",
     "required": false
    },
    {
     "name": "payer",
     "type": "string",
     "required": false
    },
    {
     "name": "description",
     "type": "string",
     "required": false
    },
    {
     "name": "reference",
     "type": "string",
     "required": false
    },
    {
     "name": "notes",
     "type": "string",
     "required": false
    },
    {
     "name": "gross",
     "type": "array of any",
     "required": false
    },
    {
     "name": "cis_deducted",
     "type": "any",
     "required": false
    },
    {
     "name": "vat",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/income#put-api-companies-companyid-income-id"
  },
  {
   "section": "simplebooks",
   "resource": "income",
   "method": "DELETE",
   "path": "/api/companies/:companyId/income/:id",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/income/:id",
   "summary": "Delete income",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId",
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/income#delete-api-companies-companyid-income-id"
  },
  {
   "section": "simplebooks",
   "resource": "tax-return",
   "method": "GET",
   "path": "/api/companies/:companyId/tax-return",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/tax-return",
   "summary": "A year's Self Assessment figures",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "tax_year"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/tax-return#get-api-companies-companyid-tax-return"
  },
  {
   "section": "simplebooks",
   "resource": "tax-return",
   "method": "PUT",
   "path": "/api/companies/:companyId/tax-return",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/tax-return",
   "summary": "Save Self Assessment choices",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "tax_year",
     "type": "any",
     "required": false
    },
    {
     "name": "use_trading_allowance",
     "type": "any",
     "required": false
    },
    {
     "name": "notes",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/tax-return#put-api-companies-companyid-tax-return"
  },
  {
   "section": "simplebooks",
   "resource": "tax-return",
   "method": "POST",
   "path": "/api/companies/:companyId/tax-return/file",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/tax-return/file",
   "summary": "Mark a year filed",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "tax_year",
     "type": "any",
     "required": false
    },
    {
     "name": "hmrc_reference",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/tax-return#post-api-companies-companyid-tax-return-file"
  },
  {
   "section": "simplebooks",
   "resource": "tax-return",
   "method": "POST",
   "path": "/api/companies/:companyId/tax-return/reopen",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/tax-return/reopen",
   "summary": "Reopen a filed year",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [],
   "body": [
    {
     "name": "tax_year",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/tax-return#post-api-companies-companyid-tax-return-reopen"
  },
  {
   "section": "simplebooks",
   "resource": "tax-return",
   "method": "GET",
   "path": "/api/companies/:companyId/tax-return/pdf",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/tax-return/pdf",
   "summary": "Self Assessment summary as PDF",
   "auth": [
    "Signed-in browser session (the `sso_session` / `session_id` cookies from Bramble sign-in).",
    "Licence: SimpleBooks."
   ],
   "params": [
    "companyId"
   ],
   "query": [
    "tax_year",
    "download"
   ],
   "body": [],
   "docs": "/developers/reference/simplebooks/tax-return#get-api-companies-companyid-tax-return-pdf"
  },
  {
   "section": "simplebooks",
   "resource": "share-target",
   "method": "POST",
   "path": "/share-target",
   "url": "https://<your-org>.brambleit.cloud/simplebooks/share-target",
   "summary": "\"Share → SimpleBooks\" is normally caught by the service worker; if it isn't running yet, just open the app",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/share-target#post-share-target"
  },
  {
   "section": "simplebooks",
   "resource": "legacy",
   "method": "GET",
   "path": "/app/simplebooks/version",
   "url": "https://<your-org>.brambleit.cloud/api/app/simplebooks/version",
   "summary": "Version (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/legacy#get-app-simplebooks-version"
  },
  {
   "section": "simplebooks",
   "resource": "legacy",
   "method": "GET",
   "path": "/app/simplebooks/companies",
   "url": "https://<your-org>.brambleit.cloud/api/app/simplebooks/companies",
   "summary": "List companies (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/legacy#get-app-simplebooks-companies"
  },
  {
   "section": "simplebooks",
   "resource": "legacy",
   "method": "GET",
   "path": "/app/simplebooks/companies/has-membership",
   "url": "https://<your-org>.brambleit.cloud/api/app/simplebooks/companies/has-membership",
   "summary": "Does the person have a company? (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/simplebooks/legacy#get-app-simplebooks-companies-has-membership"
  },
  {
   "section": "simplebooks",
   "resource": "legacy",
   "method": "POST",
   "path": "/app/simplebooks/companies/create",
   "url": "https://<your-org>.brambleit.cloud/api/app/simplebooks/companies/create",
   "summary": "Create a company (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "formObject",
     "type": "any",
     "required": false
    }
   ],
   "docs": "/developers/reference/simplebooks/legacy#post-app-simplebooks-companies-create"
  },
  {
   "section": "simplebooks",
   "resource": "legacy",
   "method": "POST",
   "path": "/app/simplebooks/company/receipts",
   "url": "https://<your-org>.brambleit.cloud/api/app/simplebooks/company/receipts",
   "summary": "Receipts for a month (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "company_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "fiscal_year",
     "type": "any",
     "required": true
    },
    {
     "name": "fiscal_month",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/simplebooks/legacy#post-app-simplebooks-company-receipts"
  },
  {
   "section": "simplebooks",
   "resource": "legacy",
   "method": "POST",
   "path": "/app/simplebooks/company/receipts/total/year",
   "url": "https://<your-org>.brambleit.cloud/api/app/simplebooks/company/receipts/total/year",
   "summary": "Year total (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "company_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "fiscal_year",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/simplebooks/legacy#post-app-simplebooks-company-receipts-total-year"
  },
  {
   "section": "simplebooks",
   "resource": "legacy",
   "method": "POST",
   "path": "/app/simplebooks/company/receipts/total/month",
   "url": "https://<your-org>.brambleit.cloud/api/app/simplebooks/company/receipts/total/month",
   "summary": "Month total (legacy)",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "company_id",
     "type": "integer",
     "required": true
    },
    {
     "name": "fiscal_year",
     "type": "any",
     "required": true
    },
    {
     "name": "fiscal_month",
     "type": "any",
     "required": true
    }
   ],
   "docs": "/developers/reference/simplebooks/legacy#post-app-simplebooks-company-receipts-total-month"
  },
  {
   "section": "partner",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/partner/me",
   "url": "https://<your-org>.brambleit.cloud/api/v1/partner/me",
   "summary": "Your partner access",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/partner/customers#get-v1-partner-me"
  },
  {
   "section": "partner",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/partner/customers",
   "url": "https://<your-org>.brambleit.cloud/api/v1/partner/customers",
   "summary": "Your customers with health summaries",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/partner/customers#get-v1-partner-customers"
  },
  {
   "section": "partner",
   "resource": "requests",
   "method": "POST",
   "path": "/v1/partner/requests",
   "url": "https://<your-org>.brambleit.cloud/api/v1/partner/requests",
   "summary": "Ask to manage an organisation",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [
    {
     "name": "domain",
     "type": "string",
     "required": false
    },
    {
     "name": "permissions",
     "type": "array of any",
     "required": false
    },
    {
     "name": "note",
     "type": "string",
     "required": false
    }
   ],
   "docs": "/developers/reference/partner/requests#post-v1-partner-requests"
  },
  {
   "section": "partner",
   "resource": "requests",
   "method": "POST",
   "path": "/v1/partner/requests/:id/withdraw",
   "url": "https://<your-org>.brambleit.cloud/api/v1/partner/requests/:id/withdraw",
   "summary": "Withdraw a request",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [
    "id"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/partner/requests#post-v1-partner-requests-id-withdraw"
  },
  {
   "section": "partner",
   "resource": "customers",
   "method": "GET",
   "path": "/v1/partner/activity",
   "url": "https://<your-org>.brambleit.cloud/api/v1/partner/activity",
   "summary": "Recent activity across your customers",
   "auth": [
    "Signed-in session, `X-API-Key`, or a Bramble app access token (`Authorization: Bearer`)."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/partner/customers#get-v1-partner-activity"
  },
  {
   "section": "status",
   "resource": "public",
   "method": "GET",
   "path": "/api/v1/status.json",
   "url": "https://status.brambleit.com/api/v1/status.json",
   "summary": "Current status of the main public page: services, sections, open incidents and maintenance",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/status/public#get-api-v1-status-json"
  },
  {
   "section": "status",
   "resource": "public",
   "method": "GET",
   "path": "/api/v1/:slug/status.json",
   "url": "https://status.brambleit.com/api/v1/:slug/status.json",
   "summary": "The same for another public status page, by its slug",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "slug"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/status/public#get-api-v1-slug-status-json"
  },
  {
   "section": "status",
   "resource": "public",
   "method": "GET",
   "path": "/api/v1/chart",
   "url": "https://status.brambleit.com/api/v1/chart",
   "summary": "Response-time chart for one monitor",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/status/public#get-api-v1-chart"
  },
  {
   "section": "status",
   "resource": "public",
   "method": "GET",
   "path": "/api/v1/day",
   "url": "https://status.brambleit.com/api/v1/day",
   "summary": "One day of a service (`k=c<id>`) or section (`k=g<id>`) as hourly bars",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/status/public#get-api-v1-day"
  },
  {
   "section": "status",
   "resource": "public",
   "method": "POST",
   "path": "/api/push/:token",
   "url": "https://status.brambleit.com/api/push/:token",
   "summary": "Heartbeat for a push monitor (GET works too)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "token"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/status/public#post-api-push-token"
  },
  {
   "section": "status",
   "resource": "public",
   "method": "GET",
   "path": "/:slug/feed.rss",
   "url": "https://status.brambleit.com/:slug/feed.rss",
   "summary": "RSS feed of a public page's incidents (`feed.atom` for Atom)",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [
    "slug"
   ],
   "query": [],
   "body": [],
   "docs": "/developers/reference/status/public#get-slug-feed-rss"
  },
  {
   "section": "gateway",
   "resource": "tenant-info",
   "method": "GET",
   "path": "/__tenant-info",
   "url": "https://<your-org>.brambleit.cloud/__tenant-info",
   "summary": "So the login page can brand itself for whichever tenant vanity domain it's being loaded on — {name, slug, domain}, or {tenant:null} on sso.brambleit.cloud / …",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/gateway/tenant-info#get-tenant-info"
  },
  {
   "section": "gateway",
   "resource": "well-known",
   "method": "ALL",
   "path": "/.well-known/caldav",
   "url": "https://<your-org>.brambleit.cloud/.well-known/caldav",
   "summary": "CalDAV / CardDAV service discovery (RFC 6764): phones and desktop apps given just the host look here first",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/gateway/well-known#all-well-known-caldav"
  },
  {
   "section": "gateway",
   "resource": "well-known",
   "method": "ALL",
   "path": "/.well-known/carddav",
   "url": "https://<your-org>.brambleit.cloud/.well-known/carddav",
   "summary": "CalDAV / CardDAV service discovery (RFC 6764): phones and desktop apps given just the host look here first",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/gateway/well-known#all-well-known-carddav"
  },
  {
   "section": "gateway",
   "resource": "general",
   "method": "GET",
   "path": "/",
   "url": "https://<your-org>.brambleit.cloud/",
   "summary": "Get the item",
   "auth": [
    "None: public, or protected by a token in the address or body."
   ],
   "params": [],
   "query": [],
   "body": [],
   "docs": "/developers/reference/gateway/general#get"
  }
 ]
}