Placement API

List placements.

Retrieve a cursor-paginated list of V2 placements for the marketplace. The response uses external placement identifiers, which match slotId on public sponsored-brand campaigns.

get/public/v1/placement-service/placements

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/placement-service/placements
  • Auth: HTTP bearer

Query parameters

searchstring nullable

Search by name, external_placement_id, or template name.

order_by'name' | 'external_placement_id' | 'template_name'

The dimension to order placements by.

Field to order placements by.

direction'asc' | 'desc'

Enumeration for ordering direction.

Direction to order placements (asc or desc).

next_pagestring nullable

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

limitinteger

Limit of placements to retrieve.

json_template_idstring uuid nullable

Filter by JSON template ID.

Response

Successful Response

hasMoreboolean required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

nextPagestring nullable

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Example response

{
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Changes

No recorded changes to this operation across all 1 revision of this API.