# List a channel's sponsored-products placements

`GET /platform/v1/channels/{channel_id}/sponsored-placements`

## Request example

```bash
curl --request GET \
  --url 'https://api.eu1.luigisbox.ai/platform/v1/channels/<channel_id>/sponsored-placements?page=1&size=20' \
  --header 'Authorization: Bearer <access_token>'
```

## Path Parameters

| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
| `channel_id` | `string` | Yes | Channel Id | — |

## Query Parameters

| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
| `status` | `anyOf(string, null)` | No | Keep only this status. | — |
| `page` | `integer` | No | Page | >= 1 |
| `size` | `integer` | No | Size | >= 1; <= 100 |

## Responses

| Status | Description | Content |
|---|---|---|
| `200` | Successful Response | application/json: object |
| `400` | Malformed request | application/json: object |
| `401` | Missing or invalid credentials | application/json: object |
| `403` | Authenticated but not permitted | application/json: object |
| `422` | Request validation failed | application/json: object |

### 200

Successful Response

#### application/json

Schema: `object`

##### Attributes

| Attribute | Type | Required | Description | Constraints |
|---|---|---|---|---|
| `items` | `Array<object>` | Yes | Items | — |
| `items[].channel_id` | `string` | Yes | Channel Id | — |
| `items[].config` | `object` | Yes | The placement-level half of a cruxo config — the per-channel caps on how many<br>sponsored objects a response may carry. | — |
| `items[].config.max_placements_pin` | `integer` | No | Max Placements Pin | >= 0; <= 100 |
| `items[].config.max_placements_promote` | `integer` | No | Max Placements Promote | >= 0; <= 100 |
| `items[].created_at` | `string` | Yes | Created At | format: date-time |
| `items[].created_by` | `anyOf(string, null)` | Yes | Created By | — |
| `items[].sponsored_provider_id` | `string` | Yes | Sponsored Provider Id | — |
| `items[].status` | `string` | Yes | Lifecycle state of a sponsored-products provider or placement.<br><br>Only an ``active`` one serves sponsored objects. A ``disabled`` one stops<br>serving shortly after the change and stays editable over the API. | allowed values: active, disabled |
| `items[].surface_ids` | `Array<string>` | Yes | Surface Ids | — |
| `items[].surface_kinds` | `Array<string>` | Yes | Surface Kinds | — |
| `items[].updated_at` | `string` | Yes | Updated At | format: date-time |
| `items[].updated_by` | `anyOf(string, null)` | Yes | Updated By | — |
| `page` | `integer` | Yes | Page | — |
| `size` | `integer` | Yes | Size | — |
| `total` | `integer` | Yes | Total | — |

##### Response example

```json
{
  "items": [
    {
      "channel_id": "example",
      "config": {
        "max_placements_pin": 20,
        "max_placements_promote": 3
      },
      "created_at": "2026-04-15T12:00:00Z",
      "created_by": "example",
      "sponsored_provider_id": "example",
      "status": "active",
      "surface_ids": [
        "example"
      ],
      "surface_kinds": [
        "search"
      ],
      "updated_at": "2026-04-15T12:00:00Z",
      "updated_by": "example"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1
}
```

### 400

Malformed request

#### application/json

Schema: `object`

##### Attributes

| Attribute | Type | Required | Description | Constraints |
|---|---|---|---|---|
| `exception_details` | `object` | No | Machine-readable error context; empty object when there is nothing to add. | — |
| `exception_details.validation_errors` | `anyOf(Array<object>, null)` | No | Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value. | — |
| `exception_details.validation_errors[].loc` | `Array<anyOf(string, integer)>` | Yes | Path to the offending value from the request root, e.g. `["body", "filters", 0, "operator"]`. | — |
| `exception_details.validation_errors[].msg` | `string` | Yes | What is wrong with the value at `loc`. | — |
| `exception_details.validation_errors[].type` | `string` | Yes | Stable machine code for the problem, e.g. `missing` or `string_too_short`. | — |
| `exception_details.*` | `any` | No | Additional property. | — |
| `reason` | `string` | Yes | Human-readable, actionable error message. | — |
| `request_id` | `anyOf(string, null)` | No | Request correlation ID (matches the X-Request-Id response header). | — |

##### Response example

```json
{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}
```

### 401

Missing or invalid credentials

#### application/json

Schema: `object`

##### Attributes

| Attribute | Type | Required | Description | Constraints |
|---|---|---|---|---|
| `exception_details` | `object` | No | Machine-readable error context; empty object when there is nothing to add. | — |
| `exception_details.validation_errors` | `anyOf(Array<object>, null)` | No | Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value. | — |
| `exception_details.validation_errors[].loc` | `Array<anyOf(string, integer)>` | Yes | Path to the offending value from the request root, e.g. `["body", "filters", 0, "operator"]`. | — |
| `exception_details.validation_errors[].msg` | `string` | Yes | What is wrong with the value at `loc`. | — |
| `exception_details.validation_errors[].type` | `string` | Yes | Stable machine code for the problem, e.g. `missing` or `string_too_short`. | — |
| `exception_details.*` | `any` | No | Additional property. | — |
| `reason` | `string` | Yes | Human-readable, actionable error message. | — |
| `request_id` | `anyOf(string, null)` | No | Request correlation ID (matches the X-Request-Id response header). | — |

##### Response example

```json
{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}
```

### 403

Authenticated but not permitted

#### application/json

Schema: `object`

##### Attributes

| Attribute | Type | Required | Description | Constraints |
|---|---|---|---|---|
| `exception_details` | `object` | No | Machine-readable error context; empty object when there is nothing to add. | — |
| `exception_details.validation_errors` | `anyOf(Array<object>, null)` | No | Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value. | — |
| `exception_details.validation_errors[].loc` | `Array<anyOf(string, integer)>` | Yes | Path to the offending value from the request root, e.g. `["body", "filters", 0, "operator"]`. | — |
| `exception_details.validation_errors[].msg` | `string` | Yes | What is wrong with the value at `loc`. | — |
| `exception_details.validation_errors[].type` | `string` | Yes | Stable machine code for the problem, e.g. `missing` or `string_too_short`. | — |
| `exception_details.*` | `any` | No | Additional property. | — |
| `reason` | `string` | Yes | Human-readable, actionable error message. | — |
| `request_id` | `anyOf(string, null)` | No | Request correlation ID (matches the X-Request-Id response header). | — |

##### Response example

```json
{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}
```

### 422

Request validation failed

#### application/json

Schema: `object`

##### Attributes

| Attribute | Type | Required | Description | Constraints |
|---|---|---|---|---|
| `exception_details` | `object` | No | Machine-readable error context; empty object when there is nothing to add. | — |
| `exception_details.validation_errors` | `anyOf(Array<object>, null)` | No | Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value. | — |
| `exception_details.validation_errors[].loc` | `Array<anyOf(string, integer)>` | Yes | Path to the offending value from the request root, e.g. `["body", "filters", 0, "operator"]`. | — |
| `exception_details.validation_errors[].msg` | `string` | Yes | What is wrong with the value at `loc`. | — |
| `exception_details.validation_errors[].type` | `string` | Yes | Stable machine code for the problem, e.g. `missing` or `string_too_short`. | — |
| `exception_details.*` | `any` | No | Additional property. | — |
| `reason` | `string` | Yes | Human-readable, actionable error message. | — |
| `request_id` | `anyOf(string, null)` | No | Request correlation ID (matches the X-Request-Id response header). | — |

##### Response example

```json
{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}
```