supplements

Get Supplements

Changed on Nov 3, 2026

Use this endpoint to get a list of supplements for the current location. The page start index begins at 0. The default page size is 25. Pagination parameters are optional. Supported includes: items, notations. Example: /supplements?pageSize=25&pageStartIndex=0&includes=items,notations&jobId=e591bf22-9828-4144-bca8-42cbb8c6e2c0

get/supplements

Request

Base URL
https://api.acculynx.com/api/v2
URL
https://api.acculynx.com/api/v2/supplements
Auth
HTTP bearer

Query parameters

pageSizeinteger

How many items to be returned at a time.

recordStartIndexinteger

The zero-based index of the first record to return.

includesstring

A comma-separated list of related resources to expand inline in the response. Valid values vary by endpoint and are documented in each operation description.

jobIdstring uuid

The job's unique identifier

Response

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "b195ca49-aeff-4e19-8ddd-193e01f5e649",
      "_link": "https://api.acculynx.com/api/v2/supplements/b195ca49-aeff-4e19-8ddd-193e01f5e649",
      "status": {
        "id": "528806c3-c914-498a-80c7-59a98eb9bd44",
        "_link": "https://api.acculynx.com/api/v2/company-settings/supplements/statuses/528806c3-c914-498a-80c7-59a98eb9bd44"
      },
      "name": "Supplement #1",
      "state": {
        "supplementState": "InProgress"
      },
      "job": {
        "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
        "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0"
      },
      "assignedSupplementer": {
        "supplementerAssigned": {
          "id": "228db892-3b49-4455-b839-ffd8576d8731",
          "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
        },
        "assignedDate": "2024-01-20T21:18:25Z",
        "assignedBy": {
          "id": "228db892-3b49-4455-b839-ffd8576d8731",
          "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
        }
      },
      "itemsToSupplement": {
        "totalOriginalClaimAmount": 1200.6,
        "totalRequestedAmount": 1600.05,
        "totalApprovedAmount": 1700.4,
        "totalAppliedAmount": 1400.48,
        "items": [
          {
            "id": "a646a794-4265-4b2b-bf01-1aa4afe127de",
            "_link": "https://api.acculynx.com/api/v2/supplements/b195ca49-aeff-4e19-8ddd-193e01f5e649/items/a646a794-4265-4b2b-bf01-1aa4afe127de",
            "name": "supplement item",
            "originalClaimAmount": 650.6,
            "requestedAmount": 1100.05,
            "approvedAmount": 1100.4,
            "appliedAmount": 900.48
          }
        ]
      },
      "notations": [
        {
          "id": "a646a794-4265-4b2b-bf01-1aa4afe127de",
          "_link": "https://api.acculynx.com/api/v2/supplements/b195ca49-aeff-4e19-8ddd-193e01f5e649/notations/a646a794-4265-4b2b-bf01-1aa4afe127de",
          "status": {
            "id": "528806c3-c914-498a-80c7-59a98eb9bd44",
            "_link": "https://api.acculynx.com/api/v2/company-settings/supplements/statuses/528806c3-c914-498a-80c7-59a98eb9bd44"
          },
          "spokeWith": "salesGuy",
          "notes": "notation note",
          "phone": "(123) 456-7891",
          "extension": "111",
          "fax": "(132) 456-7890",
          "email": "salesGuy@acculynx.com",
          "createdBy": {
            "id": "228db892-3b49-4455-b839-ffd8576d8731",
            "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
          },
          "createdDate": "2024-01-20T21:18:25Z",
          "emailRecipients": [
            {
              "id": 2,
              "companyUser": {
                "id": "228db892-3b49-4455-b839-ffd8576d8731",
                "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
              }
            }
          ]
        }
      ],
      "createdDate": "2024-01-20T21:18:25Z",
      "createdBy": {
        "id": "228db892-3b49-4455-b839-ffd8576d8731",
        "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
      },
      "editedDate": "2024-01-20T21:18:25Z",
      "editedBy": {
        "id": "228db892-3b49-4455-b839-ffd8576d8731",
        "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
      },
      "closedDate": "2024-01-20T21:18:25Z",
      "closedBy": {
        "id": "228db892-3b49-4455-b839-ffd8576d8731",
        "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
      },
      "appliedDate": "2024-01-20T21:18:25Z",
      "appliedBy": {
        "id": "228db892-3b49-4455-b839-ffd8576d8731",
        "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
      }
    }
  ]
}

Changes

Nov 3, 2026443924b00f43 Revision changes
- breaking
  for the query request parameter pageSize, default value 25 was removed
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the optional property to the response with the status

Operation history