v1Resources/SEO/getRead typed keyword fields, campaign history and accessible saved views
Read typed keyword fields, campaign history and accessible saved views
Requires both website flags, an identified active agency user with SEO access, and access to this unarchived website or client. Private views belong to that user. Field definitions and team views require owner or admin; authorized members may edit values and campaigns. Never starts rank checks or spends credits.
get
seo:read/api/v1/seo/website-keywords/workspaceQuery parameters
locationIdstringrequired
configstringoptional
JSON-encoded columns, filters, campaignMonth and sorting. Omit for the default view.
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409Stale expectedVersion, or a mutationId reused with a different command.
413The request is larger than 1 MB.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The operation could not be completed.
get/api/v1/seo/website-keywords/workspace
Your API key
locationId *
config
{}Guides that use this resource
- What Is a Local SEO API?A local SEO API measures how a business ranks in local search, with geo-grid rank tracking, profile analytics and AI visibility, not just backlinks.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build an AI Agent for Local SEOBuild an AI agent that audits and fixes listings, tracks local rankings, checks AI visibility and drafts review replies with Synup's MCP server or REST tools.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.
- Local SEO APIs: What Developers Actually NeedA practical checklist of what a local SEO API must cover, from listings and sync status to reviews, rank tracking and AI visibility, mapped to endpoints.
- How to Track Local Rankings with an APITrack local search rankings on a geo grid through an API, add keywords, read the grid and trend, and compare against competitors and citation coverage.
- How to Monitor Local SEO Across Multiple LocationsMonitor local SEO across hundreds of locations through rollup endpoints, with rank and AI visibility per location and the weakest surfaced first.
- Fetch Local Keyword Rankings via APITrack local search rankings on a geo grid with the Synup API, add keywords for a location, and read the rank trend once the background scan lands.