GET
/api/v4/connected-accounts/{connectedAccountId}/details接続済みアカウントの詳細を取得
接続済みのGoogleまたはFacebookアカウントをIDで指定し、その1件の詳細を返します。
パラメーター
パス
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| connectedAccountId | string | 必須 | UUID of the connected account (from the list connected accounts endpoint). |
レスポンス
200Connected account details.
{ "data": { "connectedAccountDetails": { "details": { "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.
connectedAccountIdで指定した接続済みアカウント1件の完全な詳細レコードを取得します。リストエンドポイントの1件のレコードと同じフィールドを返しますが、対象が1つのアカウントに限定されるため、すでにIDを保持している場合は、リスト全体をページングするよりもコストを抑えられます。
ユースケース:接続直後のアカウントをポーリングする。 顧客がGoogleの接続フローを完了すると、connectedAccountIdを取得できますが、一致候補の取得は非同期で実行されます。このエンドポイントをポーリングしてrequestMatchesStatusを監視します。候補の準備が整うとMATCH_IN_PROGRESSからMATCH_COMPLETEDに変わり、その時点でconnection-suggestionsエンドポイントから候補を読み取れます。
ユースケース:再認証を促す。 アカウントを通じて更新を送信する前に、statusとconnectivityIssueを読み取ります。ステータスがCONNECTED以外であるか、connectivityIssueに値が設定されている場合は、OAuthの認可が期限切れになっていることを意味します。失敗する公開処理を試みる代わりに、アプリ内で顧客に再接続を促します。connectedLocationsCountは、そのアカウントに現在リンクされているListings APIの拠点数を示します。
Request
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/details' \ -H "Authorization: API $LISTINGSAPI_KEY"