Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
supplements

Get Supplement 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

get/supplements/{supplementId}/notations

Path parameters

supplementIdstring uuid required

The supplement's unique identifier

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
recordStartIndexinteger

The index of the first element to return

Response

OK

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

Example response

{
  "items": [
    {
      "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"
          }
        }
      ]
    }
  ]
}