New to Corsair? See API access, authentication, and error handling.
Databases
clear
databases.clear
Delete every value in a database while keeping the database itself; the values cannot be restored
Risk: destructive · Irreversible
Output
create
databases.create
Create a database for validating barcode values; case sensitivity is fixed at creation
Risk: write
Output
delete
databases.delete
Permanently delete a database and every value in it; refused while a service still uses it
Risk: destructive · Irreversible
Output
list
databases.list
List validation databases with their stored value count and linked services, optionally at a lighter info level
Risk: read
Output
databases full type
databases full type
showValues
databases.showValues
Search and page through the barcode values stored in a database, with exact and partial match filters and a validity filter
Risk: read
Output
values full type
values full type
update
databases.update
Rename a validation database; its stored barcode values and linked services are unchanged
Risk: write
Output
upsertValue
databases.upsertValue
Insert or update one barcode value with its response text and validity, without checking whether it already exists
Risk: write
Output
upsertValues
databases.upsertValues
Insert or update up to 100 barcode values in one request, each with its own database, response text, validity and trim setting
Risk: write
values full type
values full type
Devices
list
devices.list
List the devices that have activated the app, with their UDID
Risk: read
Output
devices full type
devices full type
update
devices.update
Rename a device, which changes how the device appears in scan records and the account device list
Risk: write
Output
Limits
retrieve
limits.retrieve
Read the account API request limits remaining for the current minute and day
Risk: read
minute full type
minute full type
day full type
day full type
Questions
create
questions.create
Create a data collection question, shown to the app user before or after a scan; choice types need answer options added separately
Risk: write
Output
list
questions.list
List data collection questions with their type and answer options
Risk: read
Output
questions full type
questions full type
Scans
delete
scans.delete
Permanently delete one or more scan records; deleted scans cannot be restored
Risk: destructive · Irreversible
Output
list
scans.list
Search and page through scan records with filters on date, service, device, user, status, barcode value and scan properties, returning each scan with its answers
Risk: read
Output
scans full type
scans full type
Services
create
services.create
Create a service: how scans are validated (record, database, postback, webview) plus scan behaviour such as symbologies, auto-sync and scanner configuration
Risk: write
Output
delete
services.delete
Permanently delete one or more services, or every service with all; deleted services cannot be restored
Risk: destructive · Irreversible
Output
list
services.list
List services with their validation method, postback URL, linked database and authorized users and questions
Risk: read
Output
services full type
services full type
update
services.update
Update a service; omitted variables keep their current value, except symbologies, which reset to the default set when left out
Risk: write
Output
Uploads
list
uploads.list
List scan uploads from devices, with the device, service, user, status and scan count for each
Risk: read
Output
uploads full type
uploads full type
Users
create
users.create
Create an app user; an email address sends an invitation and requires the user to accept it before signing in
Risk: write
Output
delete
users.delete
Permanently delete app users, or every app user with all; the account owner cannot be deleted
Risk: destructive · Irreversible
Output
list
users.list
List app users with their authorized services, device limit and creation date
Risk: read
Output
users full type
users full type
update
users.update
Update an app user: rename, change the password, or set the device limit
Risk: write
Output