Assemble Developer Portal

API docs by Redocly

Activity Map (1.0)

Download OpenAPI specification:Download

This documentation describes how to retrieve information associated with a volunteer's "near me" map

Get key information and activities

Retrieve the information associated with the 'near me' map

Responses

Response Schema: application/json
Array of objects (Team)
lat
string

The current latitude of the logged-in user, based on their primary address

lon
string

The current longitude of the logged-in user, based on their primary address

nearby_volunteer_count
integer

An indication of other volunteers that may be within range of the logged-in user

postcode
string

The postcode of the logged-in user, based on their primary address

Response samples

Content type
application/json
{
  • "teams": [
    • {
      • "id": "3521",
      • "display_name": "Headquarters",
      • "parent_id": 1424,
      • "name": "Headquarters",
      • "description": "Our main office",
      • "geo_location": 4,
      • "catchment_area_id": 2,
      • "icon": "fa fa-building",
      • "show_on_public_site": false,
      • "ceiling_enabled": false,
      • "public_url": "http://example.com",
      • "hidden": false,
      • "disabled": false,
      • "external_reference": "UK-London"
      }
    ],
  • "lat": "51.5284",
  • "lon": "-0.1331",
  • "nearby_volunteer_count": 3,
  • "postcode": "NW1 2DU"
}