Search for a group
curl --request GET \
--url https://app.planpoint.io/api/groups/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://app.planpoint.io/api/groups/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.planpoint.io/api/groups/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.planpoint.io/api/groups/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.planpoint.io/api/groups/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.planpoint.io/api/groups/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.planpoint.io/api/groups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_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>"
}Groups
Get Group
Fetch a group
GET
/
groups
/
{id}
Search for a group
curl --request GET \
--url https://app.planpoint.io/api/groups/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://app.planpoint.io/api/groups/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.planpoint.io/api/groups/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.planpoint.io/api/groups/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.planpoint.io/api/groups/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.planpoint.io/api/groups/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.planpoint.io/api/groups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_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>"
}Response
Successful operation