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.
NOTE: Any alternate publishers are not returned as individual listings. These listings are managed from the parent brand’s listing.
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 |
| 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 | string If a response to a previous request contained the |
| 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: |
| language | string Default: "en" One of the language codes that we support:
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "listings": [
- {
- "id": "string",
- "locationId": "string",
- "accountId": "string",
- "publisherId": "string",
- "status": "WAITING_ON_YEXT",
- "additionalStatus": "CONNECTED",
- "listingUrl": "string",
- "loginUrl": "string",
- "screenshotUrl": "string",
- "statusDetails": [
- {
- "code": "string",
- "type": "UNAVAILABLE_REASON",
- "message": "string",
- "actionable": true,
- "unavailableReasonType": "string"
}
], - "alternateBrands": [
- {
- "brandName": "string",
- "listingUrl": "string"
}
]
}
], - "pageToken": "string"
}
}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 |
| 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
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "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 |
| 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
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}Entity Listings: List
Retrieve all Entity Listings matching the given criteria. Includes the status of each Listing and reasons why a Listing may not be live. This endpoint currently only supports Event Listings.
The results will first be sorted by publisher and then by Entity.
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 |
| entityIds | Array of strings Defaults to all account events with a subscription. Example: entity123,entity456,entity789 |
| publisherIds | Array of strings List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account. Example: FACEBOOKEVENTS,EVENTBRITE |
| statuses | Array of strings Items Enum: "NOT_SYNCED" "SYNC_IN_PROGRESS" "LIVE" "UPDATE_IN_PROGRESS" "CANCELING_SYNC" "NOT_APPLICABLE" "DELETE_PENDING" "DELETE_FAILED" "DELETED" "SYNC_STOPPED" Defaults to all Listings whose When specified, only Listings with the provided statuses will be returned. |
| language | string Default: "en" One of the following language codes:
|
| pageToken | string If a response to a previous request contained the |
| 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 |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "nextPageToken": "string",
- "listings": [
- {
- "id": "string",
- "entityId": "string",
- "accountId": "string",
- "publisherId": "string",
- "status": "NOT_SYNCED",
- "listingUrl": "string",
- "statusDetails": [
- {
- "code": "string",
- "type": "UNAVAILABLE_REASON",
- "message": "string",
- "actionable": true,
- "unavailableReasonType": "string"
}
]
}
]
}
}Entity Listings: Delete
Deletes event listings from publishers. If deletion is not supported by the publisher, then service is removed instead.
NOTE: You can delete a maximum of 100 listings in a single request. If the number of Entity IDs multiplied by the number of Publisher IDs in your request exceeds 100, you will receive a 400 error response.
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 |
| entityIds | Array of strings Defaults to all account events with a subscription. Example: entity123,entity456,entity789 |
| publisherIds | Array of strings List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account. Example: FACEBOOKEVENTS,EVENTBRITE |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}