v1Ressourcen/Veröffentlichte Einträge/getVerzeichnisfelder abrufen
Verzeichnisfelder abrufen
Gibt die benutzerdefinierten Felder der Verzeichnistabelle eines Standorts zurück, archivierte Felder eingeschlossen, mit ihren Werten, alles in einer Antwort.
get
listings:read/api/v1/listings/directory-fieldsQuery-Parameter
locationIdstringerforderlich
Der Standort, dessen Verzeichnisfelder zurückgegeben werden. Erforderlich.
Antwort
dataobjectoptional
Die benutzerdefinierten Felder und gespeicherten Werte für einen Datensatztyp in einem Bereich.
agencyIdstringoptional
Die ID Ihres Workspace (Ihrer Agentur).
userIdstringoptional
Die ID der Person, als die die Anfrage ausgeführt wird: der Ersteller des API-Schlüssels.
recordTypestring (local_keyword | task | aeo_prompt | post | series | review_campaign | listing)optional
Die Art von Datensatz, zu der der Satz gehört: local_keyword, task, aeo_prompt, post, series, review_campaign oder listing.
scopeIdstringoptional
Die ID des Bereichs, dem der Satz gehört: der Standort oder Kunde, die Website bei AEO-Prompts oder der Workspace bei Aufgaben.
canManagebooleanoptional
Ob der Ersteller des Schlüssels in diesem Satz Felder erstellen, umbenennen und archivieren darf.
fieldsarray of objectoptional
Alle Felder des Satzes, archivierte eingeschlossen, in Anzeigereihenfolge.
idstringoptional
Die ID des Felds. Verwenden Sie sie als fieldId beim Setzen von Werten.
labelstringoptional
Der Anzeigename des Felds. Namen sind innerhalb eines Feldsatzes eindeutig, archivierte Felder eingeschlossen.
typestring (text | number | date | single_select | multi_select)optional
Der Feldtyp: text, number, date, single_select oder multi_select.
optionsarray of objectoptional
Die Auswahlmöglichkeiten eines single_select- oder multi_select-Felds. Bei anderen Typen leer.
idstringerforderlich
Die ID der Option. Auswahlwerte speichern diese ID, nicht das Label.
labelstringerforderlich
Der Anzeigename der Option, innerhalb des Felds eindeutig.
archivedbooleanoptional
True, wenn die Option stillgelegt ist: Werte, die sie bereits enthalten, behalten sie, aber sie kann nicht neu ausgewählt werden.
versionintegeroptional
Die aktuelle Version des Felds, die bei jeder Änderung steigt. Übergeben Sie sie als expectedVersion in field_update.
orderintegeroptional
Die Position des Felds im Satz, beginnend bei 0.
archivedAtstringoptional
Zeitpunkt der Archivierung des Felds oder null, solange es aktiv ist. Archivierte Felder werden weiterhin zurückgegeben.
valuesobjectoptional
Gespeicherte Werte, nach recordId und dann nach fieldId geordnet, jeweils mit value und version. Nur Datensätze ohne gespeicherte Werte fehlen; ein gelöschter Wert bleibt als null mit seiner gespeicherten Version erhalten.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
503Der Dienst ist vorübergehend nicht verfügbar. Befolgen Sie die Hinweise zur Wiederholung für diesen Vorgang.
get/api/v1/listings/directory-fields
Ihr API-Schlüssel
locationId *
{}Anleitungen, die diese Ressource verwenden
- What Is a Business Listings API?A business listings API manages a business's name, address, hours and more across many publishers at once, with sync status and duplicate detection built in.
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- Google Business Profile API vs a Listings Management APIHow Google's Business Profile API compares with a listings management API on scope, access, sync status, duplicates and reviews, and when to use each.
- 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 Manage Business Listings ProgrammaticallyKeep business listings accurate from your own system with the Synup API. Covers change detection, idempotent updates, hours, photos and sync reporting.
- What Is an AEO API?An AEO API measures how AI answer engines like ChatGPT, Gemini and Perplexity describe and recommend a business, and tracks that visibility over time.
- How to Update Business Information Across Google, Apple, Bing and DirectoriesPush one business-information change to Google, Apple, Bing and the directory network through a single API call, and verify it reached each publisher.
- How Listing Syndication WorksListing syndication takes one business record, translates it into each publisher's format, and pushes it out asynchronously, which is why sync status matters.
- 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 Manage Thousands of Business Locations via APIDesign a sync job for thousands of locations on the Synup API with cursor pagination, tags, rate-limit handling, an id map and rollup health checks.
- How to Find and Remove Duplicate Business ListingsDetect duplicate business listings across publishers, review them by confidence, and flag them for removal or dismiss them with the Synup API.
- How Duplicate Listing Suppression WorksDuplicate suppression detects listings that look like the same business, scores them by confidence, and requests removal from the publisher that controls them.
- 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 Connect and Manage Google Business Profiles via APIConnect a Google Business Profile to a location, match the account's listings, keep the profile in sync and handle reconnects with the Synup API.
- Building Publisher Integrations Directly vs Using SynupWhat it really costs to integrate Google, Apple, Bing and directories yourself, versus one API, and how to decide between them or combine both.
- 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.