GET

List Categories


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 Google's catalog of business categories.

Use it to let a site owner choose a primary or additional category before creating or updating a location. Each returned id can be assigned directly to a category on the location.

The catalog is the same for everyone, so results don't depend on the location. locationId is optional and selects whose Google credentials the catalog is read with, not which categories come back. Send it when you already have a location, and leave it out before one exists, for example in a create-location flow.

searchTerm matches against the category's localized display name. Pass a plain term rather than a query expression. Leave it out to page through the whole catalog.

Errors:

  • NOT_FOUND: locationId was set but the location isn't recorded for this site. Google isn't called.
  • GOOGLE_API_CALL_FAILED: Google returned an error. Its HTTP status is in the error data.
Authentication

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

Permissions
View SEO Settings
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/gbp/v1/categories

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?