Locations
Locations
Location package count
Returns the number of locations in the filtered set by package tier — freemium vs premium. Scope the set with filterInput/selectionType/locationIds, identical to Filter locations.
get/locations/package-count
Request
- Base URLhttps://api.synup.com/api/v4
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
filterInputstring
JSON-encoded filter object. Defaults to an empty filter (all locations).
selectionType'ALL_ITEMS' | 'SELECTED_ITEMS'
Whether to include all matching locations or an explicit selection.
locationIdsstring[]
Location IDs to include when selectionType is SELECTED_ITEMS.
archivedboolean
Filter by archived state (true/false).
approvedboolean
Filter by approved state (true/false).
archivalScheduledAtboolean
Return only locations scheduled for archival.
Headers
Synup-Versionstring required
API version date (YYYY-MM-DD).
Authorizationstring required
API key for authentication.
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.