GETapi.synup.com/api/v4/plan-sites
Get Site Details for Your Plan
This API retrieves all site details associated with a specific plan, including:
- Unique identifiers for each site
- Supported countries where the plan is available
- Site URLs for access and management
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Request
Request
curl -X GET 'https://api.synup.com/api/v4/plan-sites' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/plan-sites', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/plan-sites",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/plan-sites", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successfully retrieved site details for the plan |
401 | Unauthorized. API key is missing or invalid. |
500 | Internal server error. |
Example response
{
"data": {
"planSites": [
{
"hideAddressSupportedCountries": [],
"id": 224,
"name": "Thumbtack",
"supportedCountries": [
"US"
],
"url": "thumbtack.com"
},
{
"hideAddressSupportedCountries": [
"FR",
"DE",
"NL",
"IE",
"US",
"CA",
"AU",
"NZ",
"ES",
"GB"
],
"id": 2,
"name": "Yelp",
"supportedCountries": [
"FR",
"DE",
"NL",
"IE",
"US",
"CA",
"AU",
"NZ",
"ES",
"BE",
"GB",
"IT",
"CH",
"SE",
"PL",
"AT"
],
"url": "yelp.com"
}
]
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | |
data.planSites | array of object | required | List of sites associated with the plan |
data.planSites[].id | integer | required | Unique identifier for the site |
data.planSites[].name | string | required | Name of the site |
data.planSites[].url | string | required | URL of the site |
data.planSites[].supportedCountries | array of string | required | ISO codes of countries where the site is supported |
data.planSites[].hideAddressSupportedCountries | array of string | required | Countries where Service Area Business (SAB) is supported |