/itemflags

Details:  Item Flags

URL:  https://yourlibrary.caiasoft.com/api/itemflags/v1/{flag_code}

HTTP Verb:  GET

Authorization Required:  

NameValueRequiredNotes
X-API-KeystringYessend in header

Parameters:  

NameValueRequiredNotes
flag_codestringYesCode (Not Description) of Flag, "ALL", or "GOOGLE"
GOOGLE will show all flags identified on items associated with Google Rejections

Return Response:  
{“success”:”true/false”, “error”:”string”, “count”:”integer”, "stoplist":[ { “name”:”value” (see items-> section of table below) } ]}

NameValueNotes
successtrue/false
errorstringAPI format/key errors only. Will only be filled in when success = false
item_countintegerCount of Items with Flags Assigned
items -> itemstringItem Barcode
items -> flag_codestringFlag Code applied to Item
items -> flag_descriptionarrayLong Description of Flag
items -> assigned_dateintDate Flag was Assigned to Item

Examples:  
API Call:

https://yourlibrary.caiasoft.com/api/itemflags/v1/LARGE



API Return:

{ "success": true, "error": "", "item_count": 2, "items": [ { "item": "99606984217", "flag_code": "LARGE", "flag_description": "Oversized Item - Cannot Scan in Standard Scanner", "assigned_date": "2025-12-15" }, { "item": "99602464884", "flag_code": "LARGE", "flag_description": "Oversized Item - Cannot Scan in Standard Scanner", "assigned_date": "2025-12-15" } ] }