v1Resources/Listings Published/getList a location's directories

List a location's directories

Lists every directory a location is, or can be, listed on, with the publisher name, connected account, sync status and the reason when something needs attention, the live listing URL and whether verification is needed. Unlike /connections, it also includes directories you haven't connected yet. Directories you've opted the location out of are hidden unless includeOptedOut is true.

get/api/v1/locations/{id}/directories
listings:read
Query parameters
idstringrequired
includeOptedOutbooleanoptional
Response
dataobjectoptional
cardsobjectoptional
connectionScorenumberoptional
requiresActionintegeroptional
rowsarray of objectoptional
idstringoptional
publisherIdstringoptional
publisherNamestringoptional
accountstringoptional
statusstringoptional
liveUrlstringoptional
weightstring (very_high | high | medium | low)optional
statusReasonstringoptional
lastSyncedAtstringoptional
needsVerificationbooleanoptional
optedOutbooleanoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/locations/{id}/directories
Your API key
id *
includeOptedOut
{}

Guides that use this resource