v3

latestOpenAPI 3.1.0Proprietary (Listings API Terms of Service)2026-07-3156148214.6 KB
Posts

List of post campaigns for tags/locations.

Returns a page of bulk (multi-location) post campaigns that include a single location.

get/api/v4/locations/{locationId}/bulk-posts

Path parameters

locationIdstring required

Base64-encoded location cursor / global ID (e.g. TG9jYXRpb246MTgwMDI4OQ==). Pass it verbatim, do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API.

Query parameters

locationIdsstring

JSON-encoded filter object

JSON-encoded array of location IDs to include alongside the path location.

tagstring required

Segment/tag to pull posts from. Pass all to fetch every post for the location; omitting it returns an error.

filtersstring

JSON-encoded filter object

JSON-encoded SocialPostFiltersInput (e.g. by type, status, creationDateRange, siteUrls).

pageinteger

1-based page number for offset pagination.

perPageinteger

Number of records per page.

sortFieldsstring

JSON-encoded filter object

JSON-encoded sort object { "field": "created_at", "order": "Descending" }. field is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.

componentIdentifierstring

Filter to campaigns created by a specific component/integration.

Response

Successful response