ReferenceAtlas API

Contacts

People and locations at an organisation.

Method	Path	Summary
GET	`/api/contacts/:id`	Get a contact
PUT	`/api/contacts/:id`	Update a contact
DELETE	`/api/contacts/:id`	Delete a contact
PUT	`/api/locations/:id`	Update a location
DELETE	`/api/locations/:id`	Delete a location

#Get a contact

GET/api/contacts/:id

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

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`contact`	any

Example response

JSON

{
  "contact": null
}

Example request

JavaScript

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

#Update a contact

PUT/api/contacts/:id

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

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`primary`	any

Response 200

Field	Type	Description
`contact`	object

Example response

JSON

{
  "contact": {
    "…c": "…",
    "…v": "…"
  }
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/contacts/42', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"primary":"…"}),
});
const data = await res.json();

#Delete a contact

DELETE/api/contacts/:id

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

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

JavaScript

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

#Update a location

PUT/api/locations/:id

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

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`location`	object

Example response

JSON

{
  "location": {
    "…l": "…",
    "…v": "…"
  }
}

Example request

JavaScript

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

#Delete a location

DELETE/api/locations/:id

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

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

JavaScript

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

Was this page helpful?