PRpromorepublic
Suggestions

Get Location Suggestions

Get a list of suggestions for all locations managed by the logged user

get/locations/suggestions

Request

  • Base URL
    https://workflows.promorepublic.com/webhook/2637089f-b543-45d0-a83e-2334aada4ead/listings/sandbox/api
  • Auth
    HTTP bearer

Query parameters

querystring

Filter by name, zip, street, city, label

sortstring

The location property to sort by (ascending unless order is specified)

orderstring

use asc for ascending sort or desc for descending sort

maxinteger

Used for pagination. Maximum number of results per page.

identifierstring

The location identifier, based on your internal identification system, you want the suggestions for.

offsetinteger

Offset used for pagination. Default: 0

businessIdinteger[]

The ids of the businesses you want suggestions for

locationIdsinteger[]

The ids of the locations you want suggestions for.

Response

Successfully retrieved suggestions

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "max": 10,
    "count": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.