---
title: "Get Supplement Notations"
method: GET
path: "/supplements/{supplementId}/notations"
tags: ["supplements"]
---

# Get Supplement Notations

`GET /supplements/{supplementId}/notations`

Use this endpoint to get a list of notations for a specific supplement in the current location. StartIndex starts at 0. The default PageSize is 25. Pagination parameters are optional.
**Example:** `api/v2/supplements/{supplementId}/notations?pageSize=25&pageStartIndex=0`

## Path parameters

- `supplementId` string, uuid, required

## Query parameters

- `pageSize` integer
- `recordStartIndex` integer

## Response `200`

OK

- SupplementNotationCollection — Base structure for all paginated collection responses. This provides consistent pagination metadata across all collection endpoints.
  - `count` integer — The total number of items available across all pages. Use this to calculate the total number of pages available.
  - `pageSize` integer — The number of items per page in this response. This reflects either your requested page size or the default value.
  - `pageStartIndex` integer — The starting index of this page of results. Use with pageSize to track your position in the overall result set.
  - `items` SupplementNotation[]
    - `id` string, uuid — The Notation unique identifier.
    - `_link` string, uri — The URI of the supplement notation.
    - `status` SupplementStatusLink
      - `id` string, uuid — The supplement status unique identifier.
      - `_link` string, uri — The URI of the Supplement Status.
    - `spokeWith` string — The Notation SpokeWith Text.
    - `notes` string — The Notation Notes.
    - `phone` string — The Notation 10 digit phone number text.
    - `extension` string — The Notation Extension Text.
    - `fax` string — The Notation 10 digit fax number text.
    - `email` string, email — The Notation Email Text.
    - `createdBy` CompanyUserLink
      - `id` string, uuid — The unique GUID of the AccuLynx User.
      - `_link` string — The unique URI of the AccuLynx User.
    - `createdDate` string, date-time — The date/time when this notation was created.
    - `emailRecipients` SupplementNotationEmailRecipient[]
      - `id` integer — The identifier for the notation recipient.
      - `companyUser` CompanyUserLink
        - `id` string, uuid — The unique GUID of the AccuLynx User.
        - `_link` string — The unique URI of the AccuLynx User.

## Other responses

- `400` — Bad Request - The server cannot process the request due to a client error. Common causes: - Invalid request format - Missing required fields - Validation errors in the request data
- `401` — Unauthorized - Authentication is required or has failed. Common causes: - Missing API key - Invalid API key - Expired or deactivated API key
- `416` — Range Not Satisfiable - The requested page of results is not available. Common causes: - pageStartIndex is beyond the available data range - Invalid pagination parameters

---

[API](https://skmtc.net/acculynx/apis/acculynx-api-v2.md) · [All operations](https://skmtc.net/acculynx/apis/acculynx-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/acculynx/acculynx-api-v2/versions/3a9e3886e400/schema)
