/api/v4/listings/scansLister les listings scans
Renvoie les listings scans du compte, des plus récents aux plus anciens, sans résultats par annuaire, avec la pagination et le quota mensuel.
Paramètres
Chaîne de requête
| Nom | Type | Obligatoire | Description | Par défaut |
|---|---|---|---|---|
| page | integer | facultatif | Page number, starting at 1. | 1 |
| perPage | integer | facultatif | Scans per page, from 1 to 50. Values outside that range are brought back to it. | 20 |
Réponses
200A page of scans, newest first. List items carry no `results`; read a scan with GET /listings/scans/{scanId} for those. `quota` is the monthly allowance.
{ "data": { "listingScans": { "scans": [ { "id": "TGlzdGluZ1NjYW46Mzk0YTRhNWMtZjcwMy00NjZiLTg2NjAtMDU4MTlmNDhkZjMz", "status": "COMPLETED", "source": "DIRECTORY_SEARCH", "locationId": null, "resultsAsOf": "2026-11-05T07:01:51Z", "createdAt": "2026-11-05T07:01:08Z", "startedAt": "2026-11-05T07:01:11Z", "completedAt": "2026-11-05T07:01:51Z", "business": { "name": "Joe's Pizza", "street": "7 Carmine Street", "city": "New York", "stateIso": "NY", "postalCode": "10014", "countryIso": "US", "phone": "+12123661182" }, "summary": { "total": 62, "found": 21, "accurate": 18, "inaccurate": 2, "notFound": 41, "pending": 0, "unavailable": 0 }, "failure": null }, { "id": "TGlzdGluZ1NjYW46YWVhNjljOWQtMWJkMC00ODcxLWI1MjctOGMyOWYxNWM2ZDU4", "status": "COMPLETED", "source": "DIRECTORY_SEARCH", "locationId": null, "resultsAsOf": "2026-11-05T07:01:51Z", "createdAt": "2026-11-05T07:01:02Z", "startedAt": "2026-11-05T07:01:11Z", "completedAt": "2026-11-05T07:01:51Z", "business": { "name": "Hattie B's Hot Chicken", "street": "112 19th Ave S", "city": "Nashville", "stateIso": "TN", "postalCode": "37203", "countryIso": "US", "phone": "+16158025700" }, "summary": { "total": 62, "found": 34, "accurate": 31, "inaccurate": 2, "notFound": 28, "pending": 0, "unavailable": 0 }, "failure": null } ], "pageInfo": { "totalPages": 3, "totalRecords": 6, "hasNextPage": true, "hasPreviousPage": false }, "quota": { "limit": 50, "used": 5, "remaining": 45, "resetsAt": "2026-11-23T12:38:03Z" } } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Répertorie les scans créés par votre compte, du plus récent au plus ancien. Chaque élément contient les mêmes champs que GET /listings/scans/{scanId}, sauf que results n'est pas inclus. Le champ summary de chaque élément contient les décomptes ; transmettez son id à GET /listings/scans/{scanId} pour consulter les résultats complets.
Cas d'utilisation : un historique des audits. Affichez les scans exécutés par votre équipe, chacun avec l'entreprise concernée, son statut et summary. Faites de chaque ligne un lien vers la page du scan que vous créez à partir de GET /listings/scans/{scanId}.
Cas d'utilisation : vérifier le quota avant de créer des scans. quota indique le quota mensuel de votre forfait : limit, used, remaining et resetsAt, la date de la prochaine réinitialisation du quota. Consultez-le avant un lot de créations pour savoir combien de nouveaux scans vous pouvez encore créer. Sa valeur est null lorsque le compte ne dispose d'aucun quota, par exemple avec un forfait qui n'inclut pas les listings scans.
Pagination
page commence à 1 et perPage vaut 20 par défaut. pageInfo indique votre position : totalRecords, totalPages, hasNextPage et hasPreviousPage. Demandez les pages dans l'ordre et arrêtez-vous lorsque hasNextPage vaut false.
Remarques.
- Les scans sont conservés pendant 90 jours. Les scans plus anciens ne sont pas renvoyés.
- Le tableau
scansest vide lorsque le compte ne contient pas encore de scans. - La consultation de la liste décompte une requête de votre limite de débit. Ne l'utilisez pas pour attendre un scan : consultez directement ce scan ou utilisez le webhook
listing_scan.completed.
curl -X GET 'https://listingsapi.com/api/v4/listings/scans' \ -H "Authorization: API $LISTINGSAPI_KEY"