# Get upsell group list

`GET /api/v1/Tenants/{tenantId}/UpsellGroups`

Core API · UpsellGroups · base URL `https://core-api.ancon.io` · auth: `Access-Token` header · docs: https://ancon.dev/api/core/upsell-groups/get-upsell-group-list

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tenantId` | string (uuid) | yes |  |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Offset` | integer (int32) | no | Offset the result, defaults to 0 |
| `Limit` | integer (int32) | no | Limits how many items to get, defaults to 100 min 0, max 1000. |
| `Order` | string | no | Order the result. |
| `Search` | string | no |  |
| `Filter` | map<string, array<string>> | no | Filter the result. Filter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00 |

## Header parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `correlationId` | string | no | Correlation Id for the request |

## Responses

| Status | Description |
| --- | --- |
| 200 | OK |
| 401 | Unauthorized |
| 404 | Not Found |

### 200 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array<object> or null | no |  |
| `items[].id` | string (uuid) | no |  |
| `items[].name` | string or null | no |  |
| `items[].outletShares` | array<object> or null | no |  |
| `items[].outletShares[].id` | string (uuid) | no |  |
| `items[].outletShares[].name` | string or null | no |  |
| `items[].outletShares[].productShareType` | integer (int32) | no | Allowed values: `0`, `1`. |
| `meta` | object or null | no |  |
| `meta.count` | integer (int32) | no |  |
| `meta.offset` | integer (int32) | no |  |

#### Example

```json
{
  "items": [
    {
      "id": "054b70e6-b8d4-4eba-9e79-c893c04bf1b6",
      "name": "Upsell group 1",
      "outletShares": [
        {
          "id": "44cc47ce-7c69-4628-9cb1-379f530c6ebd",
          "name": "Outlet 1",
          "productShareType": 0
        },
        {
          "id": "d2df1b49-a8e6-4fc2-a086-fa1e8410d171",
          "name": "Outlet 2",
          "productShareType": 0
        }
      ]
    },
    {
      "id": "ac3708cb-3ab4-4e38-ad02-145425807b01",
      "name": "Upsell group 2",
      "outletShares": [
        {
          "id": "f3e3a5bd-a875-47c1-a2e3-ca069b18c7ad",
          "name": "Outlet 3",
          "productShareType": 1
        }
      ]
    }
  ],
  "meta": {
    "count": 2,
    "offset": 0
  }
}
```

### 401 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |

#### Example (from schema)

```json
{
  "message": "string"
}
```

### 404 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |
| `errorCode` | string (uuid) | no |  |

#### Example (from schema)

```json
{
  "message": "string",
  "errorCode": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

## Example request

```bash
curl -X GET "https://core-api.ancon.io/api/v1/Tenants/{tenantId}/UpsellGroups" \
  -H "Access-Token: $ANCON_TOKEN"
```