PRpromorepublic
Locations Data

Get the province/state for locations

Get a list of provinces/states, for locations available to the user, with filtering on businesses, countries, or a search text

get/locations/provinces

Request

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

Query parameters

businessIdsstring[]

Get the provinces / states of locations associated with specific Business Id(s)

countriesstring[]

Get provinces / states for locations in a country

querystring

Restricts the response to the provinces/states that contain this text, for example 'indi' would return 'Indiana' when appropriate.

maxinteger

Maximum number of items to return

offsetinteger

Offset used for pagination. Default: 0

Response

Provinces successfully retrieved

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": {
    "provinces": [
      "Province1",
      "Province2"
    ]
  }
}

Changes

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