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

# Get Supplement by ID

`GET /supplements/{supplementId}`

Use this endpoint to get a particular supplement for the current location.

## Path parameters

- `supplementId` string, uuid, required

## Response `200`

OK

- 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
- `404` — 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)