API ReferenceOrganizationsPlacements

List

List placements belonging to the authenticated organization

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired
Unique identifier of the organization

Query parameters

filter[type]enumOptional

Filter by placement type (placement, placementPushNotification, placementEmail, placementBatchActivation, or placementGroup)

Allowed values:
filter[name]stringOptional

Filter by exact placement name (unique within an organization per type)

filter[contentStrategyId]stringOptional
Filter by the ID of the content strategy linked to the placement
includestringOptional
CSV list of related resources to embed in the `included` array. Supported paths: `contentStrategy` (the direct content strategy of a non-batch placement), `slots` (the slot resources of a batch-activation or group placement), `slots.placement` (and the placement each slot references), and `slots.placement.contentStrategy` (and the content strategy of each referenced placement). Dotted paths implicitly include all intermediate resources.
page[after]stringOptional
Cursor value for the next page of results
page[size]integerOptional

Maximum number of records to return [1 - 200] (default = 200)

Response

Paginated list of placements
datalist of objects
Array of placement resources
includedlist of objectsOptional

Related resources requested via the include query parameter. Each entry is keyed by its type discriminant (contentStrategy, batchActivationSlot, placement, placementPushNotification, placementEmail).

metaobjectOptional
Pagination metadata

Errors

400
Invalid Request
401
Unauthorized Error
403
Forbidden Error
404
Does Not Exist Error
500
Internal Server Error