ReferenceAtlas API

Home & search

The home page, search across everything, things expiring soon, people (for pickers), and the password generator.

Method	Path	Summary
GET	`/api/me`	Who you are: the signed-in person and what they can do here
GET	`/api/home`	Home page summary
GET	`/api/search`	Search Atlas
GET	`/api/expiries`	Things expiring soon
GET	`/api/users`	People in the tenant (account manager pickers)
GET	`/api/generate`	Generate a strong password

#Who you are: the signed-in person and what they can do here

GET/api/me

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

Response 200

Field	Type	Description
`user`	any
`types`	array of any
`settings`	object
`settings.warn_days`	integer

Example response

JSON

{
  "user": null,
  "types": [],
  "settings": {
    "warn_days": 1
  }
}

Example request

JavaScript

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

#Home page summary

GET/api/home

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

Response 200

Field	Type	Description
`recents`	array of any
`expiring`	array of object
`expiring[].kind`	string
`expiring[].ref_id`	integer
`expiring[].field`	string
`expiring[].label`	string
`expiring[].expires_on`	string (date)
`expiring[].customer_id`	integer, or null
`counts`	object
`counts.orgs`	integer

Example response

JSON

{
  "recents": [],
  "expiring": [
    {
      "kind": "string",
      "ref_id": 7,
      "field": "string",
      "label": "Example label",
      "expires_on": "2026-11-12",
      "customer_id": 7
    }
  ],
  "counts": {
    "orgs": 1
  }
}

Example request

JavaScript

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

#Search Atlas

GET/api/search

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

Query parameters

Name	Type	Description
`q`required	any	Text to search for.
`org`	integer	Only within this organisation.

Response 200

Field	Type	Description
`results`	array of any

Example response

JSON

{
  "results": []
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/search?q=%E2%80%A6', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Things expiring soon

GET/api/expiries

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

Query parameters

Name	Type	Description
`days`	number	How far ahead to look.
`org`	integer	Only this organisation.

Response 200

Field	Type	Description
`expiries`	array of object
`expiries[].kind`	string
`expiries[].ref_id`	integer
`expiries[].field`	string
`expiries[].label`	string
`expiries[].expires_on`	string (date)
`expiries[].customer_id`	integer, or null

Example response

JSON

{
  "expiries": [
    {
      "kind": "string",
      "ref_id": 7,
      "field": "string",
      "label": "Example label",
      "expires_on": "2026-11-12",
      "customer_id": 7
    }
  ]
}

Example request

JavaScript

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

#People in the tenant (account manager pickers)

GET/api/users

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

Response 200

Field	Type	Description
`users`	array of object
`users[].id`	integer
`users[].name`	string
`users[].email`	string

Example response

JSON

{
  "users": [
    {
      "id": 42,
      "name": "Example name",
      "email": "alex@example.com"
    }
  ]
}

Example request

JavaScript

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

#Generate a strong password

GET/api/generate

A strong random password (the generator in the edit sheet).

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

Query parameters

Name	Type	Description
`length`	number	Number of characters.
`k`	any

Response 200

Field	Type	Description
`password`	string

Example response

JSON

{
  "password": "…"
}

Example request

JavaScript

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

Was this page helpful?