ReferenceDrive & Office API

Libraries

Shared libraries and their members.

Method	Path	Summary
GET	`/api/v2/libraries`	List libraries
POST	`/api/v2/libraries`	Create a library
GET	`/api/v2/libraries/:id`	Get a library
PATCH	`/api/v2/libraries/:id`	Update a library
DELETE	`/api/v2/libraries/:id`	Delete a library
GET	`/api/v2/libraries/:id/members`	A library's members
PUT	`/api/v2/libraries/:id/members`	Add or change a library member
DELETE	`/api/v2/libraries/:id/members/:type/:mid`	Remove a library member

#List libraries

GET/api/v2/libraries

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

Response 200

Field	Type	Description
`libraries`	array of any

Example response

JSON

{
  "libraries": []
}

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

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

Python

import os, requests

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

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries' -Headers $headers

#Create a library

POST/api/v2/libraries

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

Request body JSON

Name	Type	Description
`name`	string	The library's name.
`description`	string	What it's for.
`color`	any	Hex colour, e.g. `#2563eb`.

Response 201

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name","description":"string","color":"…"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/drive/api/v2/libraries', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","description":"string","color":"…"}),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/drive/api/v2/libraries",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"name":"Example name","description":"string","color":"…"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"name":"Example name","description":"string","color":"…"}'
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries' -Headers $headers -ContentType 'application/json' -Body $body

#Get a library

GET/api/v2/libraries/:id

Address: https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Drive.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5' -Headers $headers

#Update a library

PATCH/api/v2/libraries/:id

Address: https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Drive.

Path parameters

Name	Type	Description
`id`required	number

Request body JSON

Name	Type	Description
`name`	string
`description`	string
`color`	any

Response 200

Example request

Bash

curl -X PATCH 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name","description":"string","color":"…"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5', {
  method: 'PATCH',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","description":"string","color":"…"}),
});
const data = await res.json();

Python

import os, requests

r = requests.patch(
    "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"name":"Example name","description":"string","color":"…"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"name":"Example name","description":"string","color":"…"}'
Invoke-RestMethod -Method PATCH -Uri 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5' -Headers $headers -ContentType 'application/json' -Body $body

#Delete a library

DELETE/api/v2/libraries/:id

Address: https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Drive.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5' -Headers $headers

#A library's members

GET/api/v2/libraries/:id/members

Address: https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id/members
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Drive.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members' -Headers $headers

#Add or change a library member

PUT/api/v2/libraries/:id/members

Address: https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id/members
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Drive.

Path parameters

Name	Type	Description
`id`required	number

Request body JSON

Name	Type	Description
`type`	string	`user` or `group`.
`id`	number	The person's or group's id.
`role`	any	`viewer`, `editor` or `owner`.

Response 200

Example request

Bash

curl -X PUT 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"string","id":12.5,"role":"…"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members', {
  method: 'PUT',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"type":"string","id":12.5,"role":"…"}),
});
const data = await res.json();

Python

import os, requests

r = requests.put(
    "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"type":"string","id":12.5,"role":"…"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"type":"string","id":12.5,"role":"…"}'
Invoke-RestMethod -Method PUT -Uri 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members' -Headers $headers -ContentType 'application/json' -Body $body

#Remove a library member

DELETE/api/v2/libraries/:id/members/:type/:mid

Address: https://<your-org>.brambleit.cloud/drive/api/v2/libraries/:id/members/:type/:mid
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Drive.

Path parameters

Name	Type	Description
`id`required	number
`type`required	string
`mid`required	number

Response 200

Field	Type	Description
`left`	boolean

Example response

JSON

{
  "left": false
}

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members/string/12.5' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members/string/12.5', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members/string/12.5",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/drive/api/v2/libraries/12.5/members/string/12.5' -Headers $headers

Was this page helpful?