Daftar listings scans

Nama	Tipe	Wajib	Deskripsi	Default
page	integer	opsional	Page number, starting at 1.	1
perPage	integer	opsional	Scans per page, from 1 to 50. Values outside that range are brought back to it.	20

Nama

Tipe

Wajib

Deskripsi

Default

page

integer

opsional

Page number, starting at 1.

perPage

integer

opsional

Scans per page, from 1 to 50. Values outside that range are brought back to it.

Respons

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.

Response

{  "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.

Mencantumkan pemindaian yang telah dibuat oleh akun Anda, dari yang terbaru. Setiap item memiliki field yang sama dengan GET /listings/scans/{scanId}, tetapi results tidak disertakan. summary pada setiap item berisi jumlahnya; teruskan id dari item tersebut ke GET /listings/scans/{scanId} untuk membaca hasil lengkapnya.

Kasus penggunaan: riwayat audit. Tampilkan pemindaian yang telah dijalankan oleh tim Anda, masing-masing beserta bisnis, status, dan summary. Tautkan setiap baris ke halaman pemindaian yang Anda buat menggunakan GET /listings/scans/{scanId}.

Kasus penggunaan: memeriksa kuota sebelum membuat pemindaian. quota melaporkan kuota bulanan untuk paket Anda: limit, used, remaining, dan resetsAt, yaitu waktu kuota direset berikutnya. Baca informasi ini sebelum menjalankan serangkaian operasi pembuatan untuk mengetahui berapa banyak pemindaian baru yang masih dapat Anda buat. Nilainya adalah null jika akun tidak memiliki kuota, misalnya pada paket yang tidak menyertakan listings scans.

Paginasi

page dimulai dari 1 dan nilai default perPage adalah 20. pageInfo menunjukkan posisi Anda saat ini: totalRecords, totalPages, hasNextPage, dan hasPreviousPage. Minta halaman secara berurutan dan berhenti ketika hasNextPage bernilai false.

Catatan.

Pemindaian disimpan selama 90 hari. Pemindaian yang lebih lama tidak dikembalikan.
Array scans kosong jika akun belum memiliki pemindaian.
Membaca daftar menggunakan satu permintaan dari batas laju permintaan Anda. Jangan gunakan daftar ini untuk menunggu pemindaian: baca pemindaian tersebut secara langsung, atau gunakan webhook listing_scan.completed.

Parameter

Query

Respons

Paginasi