/api/v4/connected-accountsDaftar akun yang terhubung
Mengembalikan akun Google dan Facebook yang terhubung ke akun Listings API Anda, beserta kondisi koneksi dan jumlah lokasi yang ditautkan.
Parameter
Query
| Nama | Tipe | Wajib | Deskripsi | Default |
|---|---|---|---|---|
| page | integer | opsional | 1-based page number. | 1 |
| perPage | integer | opsional | Records per page. | 20 |
| publisher | string | opsional | Narrow to one publisher by account type: `GoogleAccount`, `FacebookAccount`, `AppleAccount`, `YelpAccount`, `TripadvisorAccount`, `LinkedinAccount`, `PinterestAccount`, or `TwitterAccount`. | — |
| status | string | opsional | Narrow to one connection status: `Connected`, `NotConnected`, or `ConnectionIssue`. Note the mixed case, and that these are not the values the response's own `status` field uses. | — |
Respons
200List of connected accounts with pagination metadata.
{ "data": { "connectedAccountsInfo": { "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "totalPages": 1, "totalRecords": 1 }, "records": [ { "accountId": "12345", "clientName": "owner@brightsmile-dental.com", "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "connectedAccountType": "GoogleAccount", "connectedLocationsCount": 0, "connectivityIssue": null, "email": "owner@brightsmile-dental.com", "lastFetchMatchesRequestedAt": "2026-07-06 21:43:07 UTC", "remarks": null, "requestMatches": false, "requestMatchesStatus": "MATCH_COMPLETED", "status": "CONNECTED" } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Mengembalikan semua akun Google Business Profile dan Facebook Pages yang diizinkan untuk terhubung ke akun Listings API Anda. Setiap catatan memuat kondisi koneksi (status, connectivityIssue), jumlah lokasi yang ditautkan (connectedLocationsCount), dan status pengambilan hasil pencocokan terakhir (requestMatchesStatus).
Kasus penggunaan: audit kondisi koneksi sebelum sinkronisasi. Jalankan ini di awal tugas setiap malam untuk menemukan akun yang kredensialnya sudah tidak berlaku. Setiap catatan dengan connectivityIssue yang bukan null atau status selain CONNECTED mengharuskan pelanggan memberikan otorisasi ulang melalui alur koneksi; lewati catatan tersebut agar Anda tidak menyia-nyiakan panggilan trigger-matches untuk kredensial yang sudah tidak berlaku.
Kasus penggunaan: menentukan connectedAccountId untuk panggilan selanjutnya. Endpoint trigger-matches, fetch-listings, folders, dan details semuanya menggunakan connectedAccountId sebagai kunci. Ambil daftar akun, pilih akun yang email-nya cocok dengan pelanggan, lalu gunakan kembali connectedAccountId akun tersebut.
Paginasi dan pemfilteran menggunakan parameter kueri biasa yang tidak bertingkat, bukan JSON: page, perPage, publisher, dan status. Tidak ada parameter pageInfo, filters, atau sort, dan tidak ada cara untuk mengubah urutannya: hasil selalu diurutkan berdasarkan email akun, secara menaik. Parameter lain apa pun yang Anda kirim akan diabaikan, bukan ditolak, sehingga pageInfo dalam format JSON mengembalikan halaman 1 tanpa pemberitahuan.
curl -s 'https://listingsapi.com/api/v4/connected-accounts?page=1&perPage=20&publisher=GoogleAccount&status=Connected' \ -H "Authorization: API $LISTINGSAPI_KEY"Filter status dan field status tidak menggunakan kumpulan nilai yang sama. Filter menerima Connected, NotConnected, atau ConnectionIssue; status pada setiap catatan yang dikembalikan bernilai CONNECTED, MATCH_IN_PROGRESS, atau CONNECTIVITY_ISSUE. Menggunakan kembali status dari suatu catatan sebagai filter menghasilkan nilai enum yang tidak valid dan mengembalikan 400.
Baca pageInfo.hasNextPage dan pageInfo.totalPages dalam respons untuk menentukan apakah perlu mengambil halaman berikutnya. Endpoint ini diperhitungkan dalam batas laju permintaan akun; respons 429 menyertakan header Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts' \ -H "Authorization: API $LISTINGSAPI_KEY"