---
title: "Get Supplements"
method: GET
path: "/supplements"
tags: ["supplements"]
---

# Get Supplements

`GET /supplements`

Use this endpoint to get a list of supplements for the current location. StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional. **Supported includes:** `items`, `notations`.
**Example:** `api/v2/supplements?pageSize=25&pageStartIndex=0&includes=items,notations&jobId=e591bf22-9828-4144-bca8-42cbb8c6e2c0`

## Query parameters

- `pageSize` integer
- `recordStartIndex` integer
- `includes` string
- `jobId` string, uuid

## Response `200`

OK

- SupplementCollection — 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` Supplement[]
    - `id` string, uuid — The supplement unique identifier.
    - `_link` string, uri — The URI of the supplement.
    - `status` SupplementStatusLink
      - `id` string, uuid — The supplement status unique identifier.
      - `_link` string, uri — The URI of the Supplement Status.
    - `name` string — Supplement description.
    - `state` SupplementState
      - `supplementState` 'Unknown' | 'Created' | 'InProgress' | 'Closed' | 'Applied' | 'Deleted' — The state of the Supplement.
    - `job` JobLink
      - `id` string, uuid — The job's unique ID.
      - `_link` string — The URI of this Job.
    - `assignedSupplementer` SupplementerAssigned
      - `supplementerAssigned` CompanyUserLink
        - `id` string, uuid — The unique GUID of the AccuLynx User.
        - `_link` string — The unique URI of the AccuLynx User.
      - `assignedDate` string, date-time — The date/time when the supplementer was assigned.
      - `assignedBy` CompanyUserLink
        - `id` string, uuid — The unique GUID of the AccuLynx User.
        - `_link` string — The unique URI of the AccuLynx User.
    - `itemsToSupplement` SupplementItems
      - `totalOriginalClaimAmount` number, float — Total of supplement items original claim amounts
      - `totalRequestedAmount` number, float — Total of supplement items requested amounts
      - `totalApprovedAmount` number, float — Total of supplement items approved amounts
      - `totalAppliedAmount` number, float — Total of supplement items applied amounts
      - `items` SupplementItem[]
        - `id` string, uuid — The supplement item unique identifier.
        - `_link` string, uri — The URI of the supplement item.
        - `name` string — The name of the supplement item.
        - `description` string — The supplement item description.
        - `originalClaimAmount` number, float — Supplement item original claim amount.
        - `requestedAmount` number, float — Supplement item requested amount.
        - `approvedAmount` number, float — Supplement item approved amount.
        - `appliedAmount` number, float — Supplement item amount applied to Worksheet.
    - `notations` 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.
    - `createdDate` string, date-time — The date/time when this supplement was created.
    - `createdBy` CompanyUserLink
      - `id` string, uuid — The unique GUID of the AccuLynx User.
      - `_link` string — The unique URI of the AccuLynx User.
    - `editedDate` string, date-time — The date/time when this supplement was last updated.
    - `editedBy` CompanyUserLink
      - `id` string, uuid — The unique GUID of the AccuLynx User.
      - `_link` string — The unique URI of the AccuLynx User.
    - `closedDate` string, date-time — The date/time when this supplement was closed.
    - `closedBy` CompanyUserLink
      - `id` string, uuid — The unique GUID of the AccuLynx User.
      - `_link` string — The unique URI of the AccuLynx User.
    - `appliedDate` string, date-time — The date/time when this supplement was applied.
    - `appliedBy` 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)