Synup · Schema
Synup API v4 component schemas
The 222 reusable component schemas Synup publishes across its per-endpoint OpenAPI documents on developer.synup.com, extracted verbatim into one JSON Schema bundle. Derived from openapi/synup-api-openapi.yml.
Local MarketingListings ManagementReputation ManagementLocal SEOReviewsSocial-MediaAnalyticsBusiness ListingsReview ManagementAgency Software
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/synup/main/json-schema/synup-schemas.json",
"title": "Synup API v4 component schemas",
"description": "The 222 reusable component schemas Synup publishes across its per-endpoint OpenAPI documents on developer.synup.com, extracted verbatim into one JSON Schema bundle. Derived from openapi/synup-api-openapi.yml.",
"x-generated": "2026-08-13",
"x-method": "derived",
"x-source": "openapi/synup-api-openapi.yml",
"$defs": {
"ActionChip": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"emoji": {
"type": "string"
},
"action": {
"type": "string"
}
},
"x-apidog-orders": [
"label",
"emoji",
"action"
],
"x-apidog-folder": ""
},
"ChatSession": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"socialProfileId": {
"type": "string"
},
"mode": {
"type": "string"
},
"status": {
"type": "string"
},
"messageCount": {
"type": "integer"
},
"title": {
"type": "string"
},
"createdAt": {
"type": "string"
}
},
"x-apidog-orders": [
"id",
"socialProfileId",
"mode",
"status",
"messageCount",
"title",
"createdAt"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"AddCustomersRequest": {
"type": "object",
"required": [
"input"
],
"properties": {
"input": {
"type": "object",
"required": [
"reviewCampaignId",
"locationCustomers"
],
"properties": {
"reviewCampaignId": {
"type": "string"
},
"locationCustomers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerInput"
}
}
},
"x-apidog-orders": [
"reviewCampaignId",
"locationCustomers"
],
"x-apidog-ignore-properties": []
}
},
"x-apidog-orders": [
"input"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"CustomerInput": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"phone": {
"type": "string"
}
},
"x-apidog-orders": [
"name",
"email",
"phone"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"AddLocationsInput": {
"type": "object",
"required": [
"userId",
"locationIds"
],
"properties": {
"userId": {
"type": "string",
"description": "ID of the user to associate locations with",
"examples": [
"VXNlcjoxMjMyMDE="
]
},
"locationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of location IDs to associate with the user",
"examples": [
[
"TG9jYXRpb246MTE3NjE5NQ==",
"TG9jYXRpb246MTE0NzgxNA=="
]
]
}
},
"x-apidog-orders": [
"userId",
"locationIds"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"AddLocationsResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"addLocationsForUser": {
"type": "object",
"properties": {
"status": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationAddStatus"
}
}
},
"x-apidog-orders": [
"status"
],
"x-apidog-ignore-properties": []
}
},
"x-apidog-orders": [
"addLocationsForUser"
],
"x-apidog-ignore-properties": []
}
},
"x-apidog-orders": [
"data"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"LocationAddStatus": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of error messages if any occurred",
"nullable": true
},
"locationId": {
"type": "string",
"description": "ID of the location being added"
},
"success": {
"type": "boolean",
"description": "Indicates if the location was successfully added"
}
},
"x-apidog-orders": [
"errors",
"locationId",
"success"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"CoordinateInput": {
"type": "object",
"required": [
"lat",
"lon",
"gridX",
"gridY"
],
"properties": {
"lat": {
"type": "number"
},
"lon": {
"type": "number"
},
"gridX": {
"type": "integer"
},
"gridY": {
"type": "integer"
},
"isWater": {
"type": "boolean"
}
},
"x-apidog-orders": [
"lat",
"lon",
"gridX",
"gridY",
"isWater"
],
"x-apidog-folder": ""
},
"AddKeywordRequest": {
"type": "object",
"required": [
"locationId",
"accountId",
"keyword",
"gridDistance",
"unit",
"coordinates"
],
"properties": {
"locationId": {
"type": "integer"
},
"accountId": {
"type": "integer"
},
"keyword": {
"type": "string"
},
"gridDistance": {
"type": "number"
},
"unit": {
"type": "string"
},
"coordinates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoordinateInput"
}
},
"placeId": {
"type": "string"
},
"businessName": {
"type": "string"
}
},
"x-apidog-orders": [
"locationId",
"accountId",
"keyword",
"gridDistance",
"unit",
"coordinates",
"placeId",
"businessName"
],
"x-apidog-folder": ""
},
"AddKeywordResult": {
"type": "object",
"properties": {
"keywordId": {
"type": "integer"
},
"status": {
"type": "string",
"description": "\"queued\" or \"quota_exceeded\"."
}
},
"x-apidog-orders": [
"keywordId",
"status"
],
"x-apidog-folder": ""
},
"AddOnCount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"count": {
"type": "integer"
}
},
"x-apidog-orders": [
"id",
"name",
"count"
],
"x-apidog-folder": ""
},
"RankPoint": {
"type": "object",
"properties": {
"rank": {
"type": "number",
"description": "Rank at this coordinate (-1 if not ranked)"
},
"latitude": {
"type": "number",
"format": "float",
"description": "Latitude of the grid point"
},
"longitude": {
"type": "number",
"format": "float",
"description": "Longitude of the grid point"
}
},
"x-apidog-orders": [
"rank",
"latitude",
"longitude"
],
"x-apidog-folder": ""
},
"GridReport": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Report ID"
},
"locationId": {
"type": "string",
"description": "Location ID"
},
"accountId": {
"type": "string",
"description": "Account ID"
},
"keyword": {
"type": "string",
"description": "Keyword used for rank analysis"
},
"businessName": {
"type": "string",
"description": "Exact name of the business in Google Maps"
},
"businessStreet": {
"type": "string",
"description": "Street address of the business"
},
"businessCity": {
"type": "string",
"description": "City of the business"
},
"businessState": {
"type": "string",
"description": "State of the business"
},
"businessCountry": {
"type": "string",
"description": "Country of the business"
},
"gridSize": {
"type": "integer",
"enum": [
3,
5,
7
],
"description": "Size of the grid used for analysis"
},
"gridDistance": {
"type": "number",
"description": "Grid distance value"
},
"gridDistanceUnit": {
"type": "string",
"enum": [
"mi",
"km"
],
"description": "Unit of grid distance measurement"
},
"gridDistanceInKm": {
"type": "number",
"format": "float",
"description": "Grid distance converted to kilometers"
},
"ranks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RankPoint"
},
"description": "Array of ranking results for each coordinate"
},
"averageRank": {
"type": "number",
"format": "float",
"description": "Average rank across all grid points"
},
"topOneShare": {
"type": "number",
"format": "float",
"description": "Percentage of coordinates with rank <= 3"
},
"topTwoShare": {
"type": "number",
"format": "float",
"description": "Percentage of coordinates with rank <= 10"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"COMPLETED"
],
"description": "Current status of the report"
},
"latitude": {
"type": "number",
"format": "float",
"description": "Business latitude coordinate"
},
"longitude": {
"type": "number",
"format": "float",
"description": "Business longitude coordinate"
},
"placeId": {
"type": "string",
"description": "Google Place ID of the business",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "Epoch timestamp in milliseconds"
}
},
"x-apidog-orders": [
"id",
"locationId",
"accountId",
"keyword",
"businessName",
"businessStreet",
"businessCity",
"businessState",
"businessCountry",
"gridSize",
"gridDistance",
"gridDistanceUnit",
"gridDistanceInKm",
"ranks",
"averageRank",
"topOneShare",
"topTwoShare",
"status",
"latitude",
"longitude",
"placeId",
"createdAt"
],
"x-apidog-folder": ""
},
"AllGridReportsResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"gridrankReportsByLocationId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GridReport"
}
}
},
"x-apidog-orders": [
"gridrankReportsByLocationId"
]
}
},
"x-apidog-orders": [
"data"
],
"x-apidog-folder": ""
},
"AnalyticsOverview": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"interactionsAnalyticsStats": {
"type": "object",
"properties": {
"stats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"total-reviews",
"new-reviews",
"overall-rating",
"review-response-rate"
]
},
"value": {
"type": "number"
},
"delta": {
"type": "number"
}
},
"x-apidog-orders": [
"name",
"value",
"delta"
]
}
}
},
"x-apidog-orders": [
"stats"
]
}
},
"x-apidog-orders": [
"interactionsAnalyticsStats"
]
}
},
"x-apidog-orders": [
"data"
],
"x-apidog-folder": ""
},
"AnalyticsTimeline": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"interactionsChartData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"interactionCount": {
"type": "integer"
},
"averageRating": {
"type": "number",
"nullable": true
}
},
"x-apidog-orders": [
"date",
"interactionCount",
"averageRating"
]
}
}
},
"x-apidog-orders": [
"data"
]
}
},
"x-apidog-orders": [
"interactionsChartData"
]
}
},
"x-apidog-orders": [
"data"
],
"x-apidog-folder": ""
},
"ReferenceImageAnalysis": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Textual description of the analyzed image."
}
},
"x-apidog-orders": [
"description"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"AppleConfirmedMatches": {
"type": "object",
"properties": {
"matches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppleConfirmedMatch"
}
},
"matchesCount": {
"type": "integer",
"description": "Total number of matches."
},
"pages": {
"type": "integer",
"description": "Total number of pages."
}
},
"x-apidog-orders": [
"matches",
"matchesCount",
"pages"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"AppleConfirmedMatch": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"appleBusinessId": {
"type": "string"
},
"connectedAccountId": {
"type": "string"
},
"connectedAccountLabel": {
"type": "string"
},
"connectedAccountsLocationId": {
"type": "string"
},
"lakeRecordId": {
"type": "string"
},
"matchedOn": {
"type": "string",
"format": "date-time"
},
"synupLocationId": {
"type": "integer"
}
},
"x-apidog-orders": [
"id",
"appleBusinessId",
"connectedAccountId",
"connectedAccountLabel",
"connectedAccountsLocationId",
"lakeRecordId",
"matchedOn",
"synupLocationId"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"AppleConnectedListingInfo": {
"type": "object",
"description": "Connected listing details when the source is Apple",
"properties": {
"name": {
"type": "string"
},
"street": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"zip": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"storeCode": {
"type": "string",
"nullable": true
},
"liveLink": {
"type": "string",
"nullable": true
}
},
"x-apidog-orders": [
"name",
"street",
"city",
"state",
"zip",
"country",
"phone",
"storeCode",
"liveLink"
],
"x-apidog-folder": ""
},
"MutationError": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"contextInfo": {
"type": "array",
"items": {
"type": "object",
"x-apidog-orders": []
}
}
},
"x-apidog-orders": [
"code",
"message",
"contextInfo"
],
"x-apidog-folder": ""
},
"AppleOauthBulkPayload": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"url": {
"type": "string",
"description": "OAuth link to redirect the user to (1-day TTL)."
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MutationError"
}
},
"clientMutationId": {
"type": "string"
}
},
"x-apidog-orders": [
"success",
"url",
"errors",
"clientMutationId"
],
"x-apidog-folder": ""
},
"AppleOauthBulkRequest": {
"type": "object",
"required": [
"input"
],
"properties": {
"input": {
"type": "object",
"required": [
"successUrl",
"errorUrl"
],
"properties": {
"successUrl": {
"type": "string",
"description": "Redirect URL on successful authorization."
},
"errorUrl": {
"type": "string",
"description": "Redirect URL on failed authorization."
},
"platform": {
"type": "string",
"description": "`local` (default) or `social`."
},
"entityId": {
"type": "string",
"description": "Brand ID when platform is `social`."
},
"onboarding": {
"type": "boolean"
},
"clientMutationId": {
"type": "string"
}
},
"x-apidog-orders": [
"successUrl",
"errorUrl",
"platform",
"entityId",
"onboarding",
"clientMutationId"
]
}
},
"x-apidog-orders": [
"input"
],
"x-apidog-folder": ""
},
"AppleOauthPayload": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"url": {
"type": "string",
"description": "OAuth link to redirect the user to (1-day TTL)."
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MutationError"
}
},
"clientMutationId": {
"type": "string"
}
},
"x-apidog-orders": [
"success",
"url",
"errors",
"clientMutationId"
],
"x-apidog-folder": ""
},
"AppleOauthRequest": {
"type": "object",
"required": [
"input"
],
"properties": {
"input": {
"type": "object",
"required": [
"locationId",
"successUrl",
"errorUrl"
],
"properties": {
"locationId": {
"type": "string",
"description": "Relay-encoded location ID to connect."
},
"successUrl": {
"type": "string",
"description": "Redirect URL on successful authorization."
},
"errorUrl": {
"type": "string",
"description": "Redirect URL on failed authorization."
},
"clientMutationId": {
"type": "string"
}
},
"x-apidog-orders": [
"locationId",
"successUrl",
"errorUrl",
"clientMutationId"
]
}
},
"x-apidog-orders": [
"input"
],
"x-apidog-folder": ""
},
"AppleRenewOauthPayload": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"url": {
"type": "string",
"description": "OAuth renewal link to redirect the user to (1-day TTL)."
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MutationError"
}
},
"clientMutationId": {
"type": "string"
}
},
"x-apidog-orders": [
"success",
"url",
"errors",
"clientMutationId"
],
"x-apidog-folder": ""
},
"AppleRenewOauthRequest": {
"type": "object",
"required": [
"input"
],
"properties": {
"input": {
"type": "object",
"required": [
"successUrl"
],
"properties": {
"locationId": {
"type": "string",
"description": "Relay-encoded location ID of the connection to renew."
},
"connectedAccountId": {
"type": "string",
"description": "ID of the connected Apple account to renew (alternative to locationId)."
},
"successUrl": {
"type": "string",
"description": "Redirect URL on successful re-authorization."
},
"clientMutationId": {
"type": "string"
}
},
"x-apidog-orders": [
"locationId",
"connectedAccountId",
"successUrl",
"clientMutationId"
]
}
},
"x-apidog-orders": [
"input"
],
"x-apidog-folder": ""
},
"BadRequestError": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"archiveKeyword": {
"type": null
}
},
"x-apidog-orders": [
"archiveKeyword"
],
"x-apidog-ignore-properties": []
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Invalid keyword ID provided"
]
}
},
"x-apidog-orders": [
"message"
],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-orders": [
"data",
"errors"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"UnauthorizedError": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"archiveKeyword": {
"type": null
}
},
"x-apidog-orders": [
"archiveKeyword"
],
"x-apidog-ignore-properties": []
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"SY90001: Not authorized to access this resource"
]
}
},
"x-apidog-orders": [
"message"
],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-orders": [
"data",
"errors"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"ArchiveIdeaRequest": {
"type": "object",
"required": [
"ideaId"
],
"properties": {
"ideaId": {
"type": "string"
}
},
"x-apidog-orders": [
"ideaId"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"MutationResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"x-apidog-orders": [
"success",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"Error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "string"
},
"contextInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-apidog-orders": [
"key",
"value"
],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-orders": [
"message",
"code",
"contextInfo"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"ArchiveLocalIdeaRequest": {
"type": "object",
"required": [
"ideaId"
],
"properties": {
"ideaId": {
"type": "string"
}
},
"x-apidog-orders": [
"ideaId"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"LocalMutationResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"$ref": "#/components/schemas/LocalError"
}
},
"x-apidog-orders": [
"success",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"LocalError": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "string"
},
"contextInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-apidog-orders": [
"key",
"value"
],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-orders": [
"message",
"code",
"contextInfo"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"ArchiveLocalSeriesRequest": {
"type": "object",
"required": [
"seriesId"
],
"properties": {
"seriesId": {
"type": "string"
}
},
"x-apidog-orders": [
"seriesId"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"ArchiveSeriesRequest": {
"type": "object",
"required": [
"seriesId"
],
"properties": {
"seriesId": {
"type": "string"
}
},
"x-apidog-orders": [
"seriesId"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"LocationAdvancedSearchFilterType": {
"type": "object",
"properties": {
"country": {
"type": "array",
"description": "Countries present across the account's locations.",
"items": {
"type": "object",
"x-apidog-orders": [],
"properties": {},
"x-apidog-ignore-properties": []
}
},
"state": {
"type": "array",
"description": "States present across the account's locations.",
"items": {
"type": "object",
"x-apidog-orders": [],
"properties": {},
"x-apidog-ignore-properties": []
}
},
"city": {
"type": "array",
"items": {
"type": "string"
}
},
"zipcode": {
"type": "array",
"items": {
"type": "string"
}
},
"customAttrs": {
"type": "array",
"description": "Custom attribute names defined for the account.",
"items": {
"type": "string"
}
}
},
"x-apidog-orders": [
"country",
"state",
"city",
"zipcode",
"customAttrs"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"LocationSearchFilterType": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"folders": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"additionalCategories": {
"type": "array",
"items": {
"type": "string"
}
},
"primaryGbpSiteCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SitePublisherCategory"
}
},
"additionalGbpSiteCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SitePublisherCategory"
}
}
},
"x-apidog-orders": [
"tags",
"folders",
"categories",
"additionalCategories",
"primaryGbpSiteCategories",
"additionalGbpSiteCategories"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"SitePublisherCategory": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the category."
},
"value": {
"type": "integer",
"description": "Internal numeric identifier of the category."
},
"id": {
"type": "string",
"description": "GBP site category identifier."
}
},
"x-apidog-orders": [
"name",
"value",
"id"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"BranchChatSessionRequest": {
"type": "object",
"required": [
"parentSessionId",
"subjectType"
],
"properties": {
"parentSessionId": {
"type": "string"
},
"subjectType": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"x-apidog-orders": [
"parentSessionId",
"subjectType",
"subjectId"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"ChatSessionResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"session": {
"$ref": "#/components/schemas/ChatSession"
},
"suggestions": {
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"x-apidog-orders": [
"success",
"session",
"suggestions",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"BranchLocalChatSessionRequest": {
"type": "object",
"required": [
"parentSessionId"
],
"properties": {
"parentSessionId": {
"type": "string"
},
"subjectType": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"x-apidog-orders": [
"parentSessionId",
"subjectType",
"subjectId"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"LocalChatSessionResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"session": {
"$ref": "#/components/schemas/LocalChatSession"
},
"suggestions": {
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"$ref": "#/components/schemas/LocalError"
}
},
"x-apidog-orders": [
"success",
"session",
"suggestions",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"LocalChatSession": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"locationId": {
"type": "integer"
},
"mode": {
"type": "string"
},
"status": {
"type": "string"
},
"messageCount": {
"type": "integer"
},
"title": {
"type": "string"
},
"subjectType": {
"type": "string"
},
"subjectId": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"x-apidog-orders": [
"id",
"locationId",
"mode",
"status",
"messageCount",
"title",
"subjectType",
"subjectId",
"createdAt",
"updatedAt"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"BrandInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"siteUrl": {
"type": "string"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"country": {
"type": "string"
}
},
"x-apidog-orders": [
"id",
"name",
"siteUrl",
"categories",
"country"
],
"x-apidog-ignore-properties": [],
"x-apidog-folder": ""
},
"Business hours": {
"type": "object",
"properties": {
"businessHours": {
"type": "array",
"description": "Business hours for each day of the week",
"items": {
"type": "object",
"properties": {
"day": {
"type": "string",
"description": "Day of the week | Special",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY",
"SPECIAL"
],
"x-apidog-enum": [
{
"value": "MONDAY",
"name": "",
"description": ""
},
{
"value": "TUESDAY",
"name": "",
"description": ""
},
{
"value": "WEDNESDAY",
"name": "",
"description": ""
},
{
"value": "THURSDAY",
"name": "",
"description": ""
},
{
"value": "FRIDAY",
"name": "",
"description": ""
},
{
"value": "SATURDAY",
"name": "",
"description": ""
},
{
"value": "SUNDAY",
"name": "",
"description": ""
},
{
"value": "SPECIAL",
"name": "",
"description": ""
}
]
},
"slots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "Opening time. Valid formats: `<HH>:<MM>am` OR `<HH>:<MM>pm` "
},
"end": {
"type": "string",
"description": "Closing time. Valid formats: `<HH>:<MM>am` OR `<HH>:<MM>pm` "
}
},
"x-apidog-orders": [
"start",
"end"
],
"title": ""
},
"description": "Array of time slots (minimum 1, maximum 2). Required only if type is OPEN.",
"title": ""
},
"type": {
"type": "string",
"description": "Type of business hours (e.g., OPEN, CLOSED, OPEN_24x7)",
"enum": [
"OPEN",
"OPEN_24x7",
"CLOSED"
],
"x-apidog-enum": [
{
"value": "OPEN",
"name": "",
"description": ""
},
{
"value": "OPEN_24x7",
"name": "",
"description": ""
},
{
# --- truncated at 32 KB (189 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/synup/refs/heads/main/json-schema/synup-schemas.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/synup-schemas"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.