loading

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 YYYYMMDD format.

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 status is not DELETED or SYNC_STOPPED.

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

language
string
Default: "en"

One of the following language codes:

  • 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)
pageToken
string

If a response to a previous request contained the nextPageToken field, pass that field's value as the pageToken parameter to retrieve the next page of data.

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.

Responses

Response samples

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

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 YYYYMMDD format.

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

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