# List sponsored-products providers

`GET /platform/v1/sponsored-providers`

List sponsored-products providers, ordered by `id`. Listing without `organization_id` spans every organization, which requires a grant that wide; name your organization instead. `GET /platform/v1/me/entitlements` returns the organizations your credentials reach, with their ids.

## Request example

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

## Query Parameters

| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
| `organization_id` | `anyOf(string, null)` | No | Only sponsored-products providers of this organization. | — |
| `platform` | `anyOf(string, null)` | No | Only accounts on this sponsored-products platform. | — |
| `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 |
| `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[].config` | `oneOf(object)` | Yes | Config | — |
| `items[].config.aliases` | `object` | No | Aliases | — |
| `items[].config.aliases.*` | `string` | No | Additional property. | — |
| `items[].config.area` | `string` | Yes | Area | >= 1 characters |
| `items[].config.base_url` | `string` | Yes | Base Url | >= 1 characters |
| `items[].config.change_item_url` | `boolean` | No | Change Item Url | — |
| `items[].config.domain` | `string` | Yes | Domain | >= 1 characters |
| `items[].config.platform` | `string` | Yes | Platform | allowed value: cruxo |
| `items[].config.position_path` | `anyOf(string, null)` | No | Position Path | — |
| `items[].config.product_id_path` | `string` | Yes | Product Id Path | >= 1 characters |
| `items[].config.service_path` | `string` | Yes | Service Path | >= 1 characters |
| `items[].config.size` | `string` | Yes | Size | >= 1 characters |
| `items[].config.test` | `anyOf(integer, null)` | No | Test | — |
| `items[].config.use_page` | `boolean` | No | Use Page | — |
| `items[].created_at` | `string` | Yes | Created At | format: date-time |
| `items[].created_by` | `anyOf(string, null)` | Yes | Created By | — |
| `items[].credentials_set` | `boolean` | Yes | Credentials Set | — |
| `items[].id` | `string` | Yes | Id | — |
| `items[].name` | `string` | Yes | Name | — |
| `items[].organization_id` | `string` | Yes | Organization 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[].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": [
    {
      "config": {
        "aliases": {
          "additionalProperty": "example"
        },
        "area": "example",
        "base_url": "example",
        "change_item_url": false,
        "domain": "example",
        "platform": "cruxo",
        "position_path": "example",
        "product_id_path": "example",
        "service_path": "example",
        "size": "example",
        "test": 1,
        "use_page": true
      },
      "created_at": "2026-04-15T12:00:00Z",
      "created_by": "example",
      "credentials_set": true,
      "id": "example",
      "name": "example",
      "organization_id": "example",
      "status": "active",
      "updated_at": "2026-04-15T12:00:00Z",
      "updated_by": "example"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1
}
```

### 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"
}
```