Groups
Get Group
Groups
Get Group
Fetch a group
GET
/
groups
/
{id}
curl --request GET \
--url https://app.planpoint.io/api/groups/{id} \
--header 'Authorization: <api-key>'
{
"_id": "objectId",
"user": "objectId",
"name": "<string>",
"websiteURL": "<string>",
"showAvailableFirst": false,
"projects": [
"objectId"
],
"namespace": "<string>",
"hostName": "<string>",
"groupLang": "en",
"linkBehavior": "Planpoint",
"accentColor": "<string>",
"groupImageUrl": "<string>",
"groupSVGUrl": "<string>",
"svgGroupId": "<string>",
"address": "<string>",
"lon": -93.75940812944687,
"lat": 43.75940812944687,
"zoomLevel": 0,
"administrators": [
"objectId"
],
"editors": [
"objectId"
],
"invites": [
{
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"level": "<string>"
}
],
"perimeter": "<string>",
"markerImageUrl": "<string>",
"targetMarker": "<string>",
"mapStyle": "Light",
"mapPointColor": "<string>",
"showAllUnits": true,
"showPrices": true,
"initialView": "List",
"unitImageOnGrid": "Unit Plan",
"pricesStartingAt": false,
"showTaxes": true,
"priceBeforeTax": true,
"showAvailability": true,
"hideSold": true,
"deliveryDates": true,
"internalURL": "<string>",
"alternativeCovers": [
"<string>"
],
"hideArea": false,
"theme": "<string>",
"showBranding": true,
"showPriceFilter": true,
"showAreaFilter": true,
"showFloorOverview": false,
"colorBase": "<string>",
"colorAccent": "<string>",
"colorHover": "<string>",
"colorButton": "<string>",
"colorButtonText": "<string>",
"colorText": "<string>"
}
Authorizations
Path Parameters
Group ID
Example:
"objectId"
Response
200
application/json
Successful operation
The response is of type object
.
curl --request GET \
--url https://app.planpoint.io/api/groups/{id} \
--header 'Authorization: <api-key>'
{
"_id": "objectId",
"user": "objectId",
"name": "<string>",
"websiteURL": "<string>",
"showAvailableFirst": false,
"projects": [
"objectId"
],
"namespace": "<string>",
"hostName": "<string>",
"groupLang": "en",
"linkBehavior": "Planpoint",
"accentColor": "<string>",
"groupImageUrl": "<string>",
"groupSVGUrl": "<string>",
"svgGroupId": "<string>",
"address": "<string>",
"lon": -93.75940812944687,
"lat": 43.75940812944687,
"zoomLevel": 0,
"administrators": [
"objectId"
],
"editors": [
"objectId"
],
"invites": [
{
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"level": "<string>"
}
],
"perimeter": "<string>",
"markerImageUrl": "<string>",
"targetMarker": "<string>",
"mapStyle": "Light",
"mapPointColor": "<string>",
"showAllUnits": true,
"showPrices": true,
"initialView": "List",
"unitImageOnGrid": "Unit Plan",
"pricesStartingAt": false,
"showTaxes": true,
"priceBeforeTax": true,
"showAvailability": true,
"hideSold": true,
"deliveryDates": true,
"internalURL": "<string>",
"alternativeCovers": [
"<string>"
],
"hideArea": false,
"theme": "<string>",
"showBranding": true,
"showPriceFilter": true,
"showAreaFilter": true,
"showFloorOverview": false,
"colorBase": "<string>",
"colorAccent": "<string>",
"colorHover": "<string>",
"colorButton": "<string>",
"colorButtonText": "<string>",
"colorText": "<string>"
}