---
title: "Get all model point fields for a product."
method: GET
path: "/api/v1/Products/{ProductId}/ModelPointFields"
tags: ["Products"]
---

# Get all model point fields for a product.

`GET /api/v1/Products/{ProductId}/ModelPointFields`

## 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/Products/{ProductId}/ModelPointFields`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/slopesoftware/apis/akur8-life-api/docs/api/v1/Products/:ProductId/ModelPointFields/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint will:
- Validate the user has permission to view the model
- Return all model point fields for the specified product
- Support pagination with offset and limit
- Support field filtering via the Fields parameter
- Include Field Name, Field ID, Description, Data Type, IsRequired flag, Scales flags, Default values, and Aliases

## Path parameters

- `ProductId` integer, required: The ID of the product to get model point fields for

## Query parameters

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

## Response `200`

OK

- PaginatedResponseGetModelPointFieldsResponseItemV1: Paginated response that will only return an offset if there are remaining pages
  - `items` GetModelPointFieldsResponseItemV1[], nullable: Items within the page
    - `fieldId` integer
    - `fieldName` string, nullable
    - `description` string, nullable
    - `dataType` 'Integer' | 'Decimal' | 'String' | 'Date' | 'Invalid' | 'Boolean' | 'DataTable' | 'DecrementTable' | 'Dynamic' | 'ScenarioTable' | 'YieldCurve' | 'List'
    - `isRequired` boolean
    - `scalesOnPurchaseOrSale` boolean
    - `defaultValueSource` 'None' | 'DefinedValue'
    - `defaultValue` string, nullable
    - `aliases` string[], nullable
    - `isSystemField` boolean
  - `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)