v1Ressources/Fiches publiées/getObtenir les champs des annuaires
Obtenir les champs des annuaires
Renvoie les champs personnalisés de la table des annuaires d'un établissement, champs archivés compris, avec leurs valeurs, le tout dans une seule réponse.
get
listings:read/api/v1/listings/directory-fieldsParamètres de requête
locationIdstringobligatoire
L'établissement dont les champs des annuaires sont renvoyés. Obligatoire.
Réponse
dataobjectfacultatif
Les champs personnalisés et les valeurs stockées pour un type d'enregistrement dans une portée.
agencyIdstringfacultatif
L'id de votre espace de travail (agence).
userIdstringfacultatif
L'id de la personne au nom de laquelle la requête s'exécute : le créateur de la clé API.
recordTypestring (local_keyword | task | aeo_prompt | post | series | review_campaign | listing)facultatif
Le type d'enregistrement auquel appartient le jeu : local_keyword, task, aeo_prompt, post, series, review_campaign ou listing.
scopeIdstringfacultatif
L'id de la portée à laquelle appartient le jeu : l'établissement ou le client, le site web pour les prompts AEO, ou l'espace de travail pour les tâches.
canManagebooleanfacultatif
Indique si le créateur de la clé peut créer, renommer et archiver des champs dans ce jeu.
fieldsarray of objectfacultatif
Tous les champs du jeu, champs archivés compris, dans l'ordre d'affichage.
idstringfacultatif
L'id du champ. Utilisez-le comme fieldId pour définir des valeurs.
labelstringfacultatif
Le nom affiché du champ. Les noms sont uniques au sein d'un jeu de champs, champs archivés compris.
typestring (text | number | date | single_select | multi_select)facultatif
Le type de champ : text, number, date, single_select ou multi_select.
optionsarray of objectfacultatif
Les choix d'un champ single_select ou multi_select. Vide pour les autres types.
idstringobligatoire
L'id de l'option. Les valeurs de sélection stockent cet id, pas le libellé.
labelstringobligatoire
Le nom affiché de l'option, unique au sein du champ.
archivedbooleanfacultatif
True quand l'option est retirée : les valeurs qui la contiennent déjà la conservent, mais elle ne peut plus être sélectionnée.
versionintegerfacultatif
La version actuelle du champ, incrémentée à chaque modification. Transmettez-la comme expectedVersion dans field_update.
orderintegerfacultatif
La position du champ dans le jeu, à partir de 0.
archivedAtstringfacultatif
Date d'archivage du champ, ou null tant qu'il est actif. Les champs archivés sont toujours renvoyés.
valuesobjectfacultatif
Valeurs stockées, indexées par recordId puis par fieldId, chacune avec value et version. Seuls les enregistrements sans aucune valeur stockée sont omis ; une valeur effacée reste présente à null avec sa version stockée.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
503Le service est temporairement indisponible. Suivez les consignes de nouvelle tentative propres à cette opération.
get/api/v1/listings/directory-fields
Votre clé API
locationId *
{}Guides qui utilisent cette ressource
- 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.