v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Placements

Get Placement IDs

Returns a paged list of all placement IDs registered in the system.

get/v1/placements/ids/{page}/{pageSize}

Path parameters

pagestring required

The page number to retrieve.

pageSizestring required

The number of placement IDs to include in each page of results.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A paged list of placement IDs.

IntegerSchema[] required