loading

Listings: List

Retrieve all Listings matching the given criteria including status and reasons why a Listing may be unavailable

The results will first be sorted by publisher and then by Location.

Support for all macro: If you would like to use this endpoint to take action on your account and all of its sub-accounts, you can use the all macro in place of your account ID in your request URLs. For more information, see the "Account ID" section of "Policies and Conventions" at the top of this page.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

limit
integer <= 100
Default: 100

Number of results to return

offset
integer
Default: 0

Number of results to skip. Used to page through results. Cannot be used together with pageToken.

locationIds
Array of strings

Defaults to all account locations with a Listings subscription.

Example: loc123,loc456,loc789

publisherIds
Array of strings

List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account.

Example: MAPQUEST,FACEBOOK

statuses
Array of strings
Items Enum: "WAITING_ON_YEXT" "WAITING_ON_CUSTOMER" "WAITING_ON_PUBLISHER" "LIVE" "UNAVAILABLE" "OPTED_OUT"

When specified, only Listings with the provided statuses will be returned

Example: WAITING_ON_YEXT,WAITING_ON_CUSTOMER

language
string
Default: "en"

One of the language codes that we support:

  • cs - Czech
  • da - Danish
  • nl - Dutch
  • en - English
  • en_GB - English (UK)
  • fi - Finnish
  • fr - French (France)
  • de - German (Germany)
  • hu - Hungarian
  • it - Italian
  • ja - Japanese
  • no - Norwegian
  • pt - Portuguese (Portugal)
  • sk - Slovak
  • es - Spanish (Spain)
  • sv - Swedish
  • tr - Turkish
  • zh_Hans - Chinese (Simplified)
  • zh_Hant - Chinese (Traditional)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Listings: Opt In

Opts designated locations into designated publishers

NOTE: The number of Location IDs multiplied by the number of Publisher IDs is capped at 100. If you exceed this, you will receive a 400 error response.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

locationIds
Array of strings

Defaults to all account locations with a Listings subscription.

Example: loc123,loc456,loc789

publisherIds
Array of strings

List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account.

Example: MAPQUEST,FACEBOOK

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": { }
}

Listings: Opt Out

Opts designated locations out of designated publishers

NOTE: The number of Location IDs multiplied by the number of Publisher IDs is capped at 100. If you exceed this, you will receive a 400 error response.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

locationIds
Array of strings

Defaults to all account locations with a Listings subscription.

Example: loc123,loc456,loc789

publisherIds
Array of strings

List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account.

Example: MAPQUEST,FACEBOOK

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": { }
}