Path Parameters

The API uses a variety of path parameters. Each API provides more information on parameters required for specific types of requests. The following table describes sample path parameters.

Name Description Type/Format Required Example API Request
orgShortName The organization identifier String Yes "tfoinc" Organization API GET {basePath}/organizations/{orgShortName}
menuId The identifier for an individual menu String Yes "1233" Configuration API GET {basePath}/menus/{menuId}
checkRef Check identifier String Yes "929aacee2c6d42c78ae877e824c28eed000 00431" Checks API POST {basePath}/checks/{checkRef}/round