Skip to main content
Codereadr logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: CODEREADR
  • Version: 20261101_00

Tools

Slug: CODEREADR_COLLECT_DATA_WITH_QUESTIONSCreate and attach custom questions to a CodeREADr service for data collection after scans. Use this to configure forms that collect additional information from users after each barcode scan. Requires a valid service ID from CODEREADR_RETRIEVE_SERVICES or CODEREADR_CREATE_SERVICE.

Input Parameters

array
required
List of questions to create and/or link to the service. Minimum 1 question required.
string
required
Numeric ID of the service to attach questions to. Get this from CODEREADR_RETRIEVE_SERVICES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_CONFIGURE_CONNECTORProvides guidance for configuring the CodeREADr Connector through the Google Sheets Add-on UI and optionally probes API connectivity. Probe results reflect HTTP reachability, not confirmed credential validity.

Input Parameters

string
Optional note to include in the resulting guidance message (for testing/logging).
boolean
If true, also attempt a legacy section/action probe as a secondary check.
boolean
If true, perform a lightweight API call to validate connectivity and API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_CREATE_SERVICECreates a new CodeREADr service (barcode scanning workflow configuration). A service defines how barcode scans are processed - whether they’re simply recorded, validated against a database, forwarded to an external URL, or display web content. Each validation_method type has different required parameters: ‘database’/‘ondevicedatabase’ require database_id, ‘postback’ requires postback_url, ‘webview’ requires description (URL/HTML).

Input Parameters

integer ("0" | "1")
Enable GPS location tracking for scans. 0 = disabled, 1 = enabled. Default is 0.
string
Required when validation_method is ‘database’ or ‘ondevicedatabase’. The ID of the database to validate scans against.
string
Service description. For ‘webview’ validation_method, this should be the URL or HTML content to display after a scan.
string
Comma-separated list of barcode type IDs to accept. If omitted, all barcode types are accepted.
string
Required when validation_method is ‘postback’. The URL to forward scan data to in real-time.
string
Human-readable name for the service. If omitted, defaults to ‘Service N’.
integer ("0" | "1")
For database services: controls duplicate scan behavior. 0 = reject duplicates, 1 = allow duplicates. Default is 1.
string ("record" | "ondevicerecord" | "database" | "ondevicedatabase" | "webview" | "postback")
required
The type of service to create. Options: ‘record’ - Simple scan recording to cloud, ‘ondevicerecord’ - Scan recording stored on device, ‘database’ - Validate scans against cloud database, ‘ondevicedatabase’ - Validate scans against on-device database, ‘webview’ - Display web content after scan, ‘postback’ - Forward scans to external URL in real-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_DELETE_DATABASEDelete a CodeREADr validation database by its ID. This permanently removes the database and all its barcode values. Use with caution. Note: A database cannot be deleted if it is currently linked to one or more services. You must unlink those services from the database first. Example: “Delete database with ID 1340798”

Input Parameters

string
required
The numeric ID of the database to delete. Use CODEREADR_RETRIEVE_DATABASES to find available database IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_DELETE_DEVICETool to delete a device from CodeREADr. Uses the CodeREADr legacy API with section=devices and action=delete parameters. Note: Device deletion may have limited support in the CodeREADr API - only ‘retrieve’ and ‘update’ actions are officially documented for devices.

Input Parameters

string
required
The numeric ID of the device to delete (integer format, e.g. ‘123’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_DELETE_QUESTIONPermanently deletes one or more custom questions from your CodeREADr account. Questions are used to collect additional data after scans. Once deleted, the question and all associated answer options are removed. This action cannot be undone.

Input Parameters

string
required
The numeric ID of the custom question to delete. Can be a single ID or comma-separated list of IDs to delete multiple questions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_DELETE_SERVICEDelete a CodeREADr service by its numeric ID. Use this to permanently remove a service/workflow configuration from your account. Note: This is a destructive action and cannot be undone. You can delete a single service, multiple services (comma-separated IDs), or all services. Example: “Delete service with ID 12345”

Input Parameters

string
required
The numeric ID of the service to delete. Can be a single ID (e.g., ‘12345’) or comma-separated list (e.g., ‘12345,12346,12347’). Use ‘all’ to delete all services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_DELETE_USERDeletes an existing user account from CodeREADr. Uses the CodeREADr legacy API endpoint (POST /api/ with section=users, action=delete). The user_id parameter can be a single ID, comma-separated list of IDs, or ‘all’. Note: You cannot delete the account owner’s app-user. The API will return an error if an invalid user_id is provided.

Input Parameters

string
required
The unique numeric identifier of the user to delete. Can be a single ID, comma-separated list of IDs, or ‘all’ to delete all users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_LIST_SUPPORTED_BARCODE_TYPESLists barcode-related entries scraped from CodeREADr’s supported barcode types page. Results are filtered by recognized name patterns by default and can be limited; the list may be incomplete or include non-barcode items.

Input Parameters

integer
Maximum number of barcode types to return. Must be a positive integer if provided. Useful for limiting response size.
boolean
If True (default), filter results to only recognized barcode symbologies (e.g., QR Code, Code 128, EAN-13). If False, returns all list items from the source page including non-barcode content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_RETRIEVE_DATABASESRetrieves all validation databases configured in your CodeREADr account. Use this to list databases for barcode validation, see their IDs, names, item counts, and which services they’re linked to.

Input Parameters

string
Controls response detail level. Options: ‘names’ (excludes services and item counts) or ‘services’ (excludes slower item counts). Leave empty for full details.
string
Single database ID or comma-separated list of IDs to retrieve. Leave empty to retrieve all databases.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_RETRIEVE_DEVICESRetrieve a list of devices registered to your CodeREADr account. This tool fetches information about devices linked to your account, including device IDs, UDIDs, names, and creation timestamps. Use this to monitor which devices have access to your CodeREADr services.

Input Parameters

string
Filter by device ID(s). Can be a single ID (e.g., ‘1005’), comma-separated IDs (e.g., ‘1005,1010,1254’), or ‘all’ for all devices. Defaults to ‘all’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_RETRIEVE_SCANSRetrieve CodeREADr scan records with filters for service, user, device, date range, status or scan ID, and limit and offset parameters. The returned list excludes records missing a scan ID, barcode value or service ID.

Input Parameters

integer
Maximum number of scan records to return. If not specified, returns all matching scans.
integer
Number of records to skip (for pagination). Use with ‘limit’ to paginate results.
string
Filter by scan status: ‘1’ for valid, ‘0’ for invalid, or ‘-1’ for all scans.
string
Retrieve a specific scan by its ID.
string
Filter by user ID. Use comma-separated values for multiple users.
string
End date/time for filtering scans in ‘YYYY-MM-DD HH:MM:SS’ format. Example: ‘2024-12-31 23:59:59’
string
Filter by device ID. Use comma-separated values for multiple devices.
string
Filter by service ID. Use comma-separated values for multiple services (e.g., ‘12345,67890’).
string
Start date/time for filtering scans in ‘YYYY-MM-DD HH:MM:SS’ format. Example: ‘2024-01-01 00:00:00’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_RETRIEVE_SERVICESRetrieve configured services from your CodeREADr account. Services are the core organizational units in CodeREADr that define how barcode scans are validated and processed. Use this action to list all services or retrieve specific services by ID.

Input Parameters

string
Optional service ID or comma-separated list of IDs to retrieve specific services. Use ‘all’ or leave empty to retrieve all services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_UPDATE_QUESTIONAdd answer options to an existing CodeREADr question. Use this to add selectable answers for checkbox, dropdown, or option-type questions. The CodeREADr API does not support updating question text - to change text, delete and recreate the question.

Input Parameters

array
required
List of answer options to add to the question. At least one option is required.
integer
required
Unique identifier of the question to update. Get this from the retrieve questions action or after creating a question.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEREADR_UPDATE_SERVICEUpdate a CodeREADr service by ID, including its name, postback URL, GPS, duplicate handling and availability settings. Omitted settings generally retain their values, but omitting symbologies resets them to the default.

Input Parameters

integer ("0" | "1")
1=enable automatic sync of on-device scans and database updates.
integer ("0" | "1")
1=include GPS coordinates with each scan, 0=disabled.
integer
required
The unique ID of the service to update. Obtain from retrieve services action.
string
ID of the database to associate (for database or ondevicedatabase validation methods).
string
New description for the service. Leave empty to keep current.
string
Comma-separated list of symbology IDs to enable. Omit to use defaults.
string
URL where scan data will be forwarded via HTTP POST. Must be a valid HTTPS URL.
string
New name for the service. Leave empty to keep current name.
string
Email address to receive CSV report after each scan upload.
integer ("0" | "1" | "2" | "3")
Auto-next scan mode: 0=disabled, 1-3=various auto-advance modes.
integer ("0" | "1")
0=users see only their own scans, 1=users see all authorized users’ scans.
1=disable database search/lookup, 0=allow database search.
integer ("0" | "1")
Duplicate scan behavior: 1=valid (allow duplicates), 0=invalid (reject duplicates).
string
Service end date in MM/DD/YYYY or YYYY-MM-DD format.
string
Service end time in hh:mm:ss or hh:mma format.
string
URL to sync scans directly when auto_sync is enabled.
integer ("0" | "1")
1=disable camera scanning, 0=allow camera scanning.
integer ("0" | "1")
1=disable manual barcode entry, 0=allow manual entry.
string
URL to open when user taps Lookup button in the app. Empty string disables the button.
string
Service start date in MM/DD/YYYY or YYYY-MM-DD format.
string
Service start time in hh:mm:ss or hh:mma format.
integer ("0" | "1")
0=disable automatic database downloads, 1=enable.
integer
Delay in seconds between scan upload attempts.
string
URL to open when user taps History button in the app. Empty string disables the button.
string
Regex pattern to match against scan values before processing.
string ("regular" | "properties")
CSV format for email reports: ‘regular’ or ‘properties’.
integer
Delay in seconds before auto-next triggers.
integer
Delay in seconds between database update checks.
integer ("0" | "1")
On-device duplicate behavior: 1=valid, 0=invalid. Ignored if duplicate_value=0.
integer ("0" | "1")
Set to 1 if postback URL only receives data, 0 if it can also respond with scan results.
string
Regex pattern to match against scan response before displaying.
string
Replacement string for regex_scan_pattern matches.
integer ("0" | "1")
Set to 1 to enable postback when on-device scans are uploaded. Requires postback_url.
integer ("0" | "1")
Set to 1 to enable real-time postback for each online scan. Requires postback_url.
string
Replacement string for regex_response_pattern matches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not