API Docs

__METHOD= GET . __PATH= /almaws/v1/task-lists/printouts .

Retrieve Printouts

This API returns a list of Printouts.

Resource URL

GET /almaws/v1/task-lists/printouts

API Description

URL Parameters


Querystring Parameters

letterxs:stringOptional. Default: ALLPrintout Name. Optional.
statusxs:stringOptional. Default: ALLPrintout status. Optional. Valid values are: Printed, Pending, Canceled.
printer_idxs:stringOptional. Default: ALLPrintout Printer
printed_byxs:stringOptional. Default: ALLPrinted by: ALL/ME. This field is relevant when using the API from within Cloud Apps.
printout_idxs:stringOptional. Default: ALLA list of Printout IDs (for example: 123,456,778) from 1 to the limit of 100 Optional. Use of this option overrides all of the filtering parameters
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.

Body Parameters



This method returns a Printouts object. See doc

Possible Error Codes

401666|40166410Invalid parameter.