Synup
Create a key
v1Resources/Listings Published/getGet Directory fields

Get Directory fields

Returns the custom fields on a location's Directory table, archived fields included, with their values, all in one response.

get/api/v1/listings/directory-fields
listings:read
Query parameters
locationIdstringrequired
The location whose Directory fields to return. Required.
Response
dataobjectoptional
The custom fields and stored values for one record type in one scope.
agencyIdstringoptional
Your workspace's (agency's) id.
userIdstringoptional
The id of the person the request runs as: the API key's creator.
recordTypestring (local_keyword | task | aeo_prompt | post | series | review_campaign | listing)optional
The kind of record the set belongs to: local_keyword, task, aeo_prompt, post, series, review_campaign or listing.
scopeIdstringoptional
The id of the scope that owns the set: the location or client, the website for AEO prompts, or the workspace for tasks.
canManagebooleanoptional
Whether the key's creator may create, rename and archive fields in this set.
fieldsarray of objectoptional
Every field in the set, archived ones included, in display order.
idstringoptional
The field's id. Use it as fieldId when setting values.
labelstringoptional
The field's display name. Names are unique within a field set, archived fields included.
typestring (text | number | date | single_select | multi_select)optional
The field type: text, number, date, single_select or multi_select.
optionsarray of objectoptional
The choices of a single_select or multi_select field. Empty for other types.
idstringrequired
The option's id. Select values store this id, not the label.
labelstringrequired
The option's display name, unique within the field.
archivedbooleanoptional
True when the option is retired: values that already hold it keep it, but it can't be newly selected.
versionintegeroptional
The field's current version, raised on every change. Pass it as expectedVersion in field_update.
orderintegeroptional
The field's position in the set, starting at 0.
archivedAtstringoptional
When the field was archived, or null while it's active. Archived fields are still returned.
valuesobjectoptional
Stored values, keyed by recordId and then by fieldId, each with value and version. Only records with no stored values are left out; a cleared value stays in the map as null with its stored version.
Errors
400The request is missing a required parameter or is otherwise malformed.
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.
503The service is temporarily unavailable. Follow the retry guidance for this operation.
get/api/v1/listings/directory-fields
Your API key
locationId *
{}

Guides that use this resource