Get Location allowlist IDs, in ascending order, one cursor-paginated page at a time.

Get Location allowlist IDs, in ascending order, one cursor-paginated page at a time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get Allowlist requests

A Get Allowlist request returns the Tripadvisor Location IDs your key is licensed to retrieve. This is the set the Location endpoints and your feeds honour.

A request is an HTTP GET to a URL in the form:

https://terra.tripadvisor.com/api/allowlist

Get Allowlist responses

The response is a paged object whose data array contains bare integers — Location IDs, not objects. The pagination object carries page, size, total_elements and total_pages.

Pages are 1-based and size defaults to 1000, so a large portfolio still requires paging.

{
  "data": [187147, 188151, 190420],
  "pagination": {
    "page": 1,
    "size": 1000,
    "total_elements": 3,
    "total_pages": 1
  }
}

Note: an ID absent from this list returns 404 from Location Details. The Catalog endpoints ignore the allowlist, which is how IDs are found before being added.

Examples

Read the first page of the allowlist

curl "https://terra.tripadvisor.com/api/allowlist?version=1" \
  -H "X-API-Key: API_KEY"

Read a smaller page

curl "https://terra.tripadvisor.com/api/allowlist?version=1&page=1&size=100" \
  -H "X-API-Key: API_KEY"

Related

Query Params
int32
1 to 1000
Defaults to 1000

maximum number of IDs to return (between 1 and 1000, defaults to 1000)

string

the pagination.next_cursor of the previous page; omit it to start from the beginning

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json