---
title: "Get model's product output groupings."
method: GET
path: "/api/v1/Models/{ModelId}/ProductOutputGroupings"
tags: ["Models"]
---

# Get model's product output groupings.

`GET /api/v1/Models/{ModelId}/ProductOutputGroupings`

## Request

- Base URL: `https://api.slopesoftware.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.slopesoftware.com/api/v1/Models/{ModelId}/ProductOutputGroupings`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/slopesoftware/apis/akur8-life-api/docs/api/v1/Models/:ModelId/ProductOutputGroupings/get.ts> (a function with typed inputs; its response is checked against the schema)

Library models are not supported and return a 403.

## Path parameters

- `ModelId` integer, required: Model Id

## Query parameters

- `Fields` string
- `Limit` integer
- `Offset` integer

## Response `200`

OK

- PaginatedResponseGetModelProductOutputGroupingsResponseItemV1: Paginated response that will only return an offset if there are remaining pages
  - `items` GetModelProductOutputGroupingsResponseItemV1[], nullable: Items within the page
    - `id` integer: Product Output Grouping ID
    - `name` string, nullable: Product Output Grouping name, or null when the grouping is unnamed.
    - `variableNames` string[], nullable: Names of the variables contained in the Product Output Grouping
    - `variableScope` GetModelProductOutputGroupingsVariableScopeV1
      - `applyToAllVariables` boolean: True when the Product Output Grouping applies to every aggregate variable.
      - `variables` string[], nullable: Names of the variables the Product Output Grouping is scoped to, in the order they were selected. Empty when none are selected.
      - `tags` string[], nullable: Names of the variable tags the Product Output Grouping is scoped to. Empty when none are selected.
  - `offset` integer, nullable: Offset to retrieve the next page. Null when there are no further records.

## Other responses

- `201`: Created
- `400`: Bad Request
- `401`: Unauthorized
- `403`: Not Allowed To Access
- `404`: Not Found
- `429`: Too Many Requests

---

[API](https://skmtc.dev/slopesoftware/apis/akur8-life-api.md) - [All operations](https://skmtc.dev/slopesoftware/apis/akur8-life-api/llms.txt) - [OpenAPI document](https://skmtc.dev/slopesoftware/apis/akur8-life-api/revisions/9771b2c79880?raw)