GET

List Attribute Metadata


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the attributes a Business Profile can have, with each one's value type, display name and options.

Use it to work out what you can send to Update Location Attributes, or to build an editor for a site owner.

Specify exactly one of:

  • locationId, for the attributes available to an existing location, based on its category and country.
  • categoryRegion, for the attributes available to a Google category and country. Use this before a location exists, for example while a site owner is still choosing a category. It doesn't need a connected Google account.

Errors:

  • INVALID_ARGUMENT: neither or both of the two lookup fields were specified.
  • NOT_FOUND: the location isn't recorded for this site. Google isn't called.
  • GOOGLE_API_CALL_FAILED: the call to Google failed. Google's status and response are in the error payload.
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage SEO Settings
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/gbp/v1/attribute-metadata

Errors
500Internal

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?