Data Collection

Codereadr

Learn how to use Codereadr with Composio

Overview

SLUG: CODEREADR

Description

CodeREADr is a mobile data collection and barcode scanning platform that enables businesses to create and manage services for data capture, validation, and reporting.

Authentication Details

generic_api_key
stringRequired

Connecting to Codereadr

Create an auth config

Use the dashboard to create an auth config for the Codereadr toolkit. This allows you to connect multiple Codereadr accounts to Composio for agents to use.

1

Select App

Navigate to Codereadr.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Codereadr Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4codereadr_auth_config_id = "ac_YOUR_CODEREADR_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Codereadr for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, codereadr_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Codereadr toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["CODEREADR"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Collect Data With Questions

Description

Tool to configure data collection forms by adding custom questions. Use after creating a service to collect survey questions after each scan.

Action Parameters

questions
arrayRequired
service_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Configure CodeREADr Connector

Description

Helper to guide configuring the CodeREADr Connector for Google Sheets. There is no public API to programmatically create connector configurations. This tool validates your API connectivity (optional) and returns clear steps to proceed via the Google Sheets Add-on UI: https://www.codereadr.com/knowledgebase/codereadr-connector-add-on/

Action Parameters

include_legacy_probe
boolean
note
string
perform_connectivity_check
booleanDefaults to True

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Configure Direct Scan URL (DSU)

Description

Tool to configure a Direct Scan URL (DSU). Use after obtaining a valid service ID to set up scan callbacks. Use when you need to enable or update the DSU postback settings for a CodeREADr service.

Action Parameters

postback_url
stringRequired
scan_properties
object
service_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Configure CodeREADr Kiosk Mode

Description

Tool to enable and configure Kiosk Mode for unattended scanning. Use when setting up a dedicated scanning kiosk after service setup.

Action Parameters

android_screen_pinning
boolean
manual_input
boolean
pin
stringRequired
stop_auto_next
boolean
webify
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Configure Picking, Delivery & Receiving App

Description

Tool to configure the complete picking, delivery, and receiving workflow. Use when setting up scan workflow endpoints for an existing CodeREADr service.

Action Parameters

dsu_postback_url
stringRequired
questions
arrayRequired
real_time_postback_url
stringRequired
service_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Configure CodeREADr Postback URL

Description

Tool to configure a real-time postback URL for a CodeREADr service. Use when you need to set up or modify scan forwarding for an existing service.

Action Parameters

postback_url
stringRequired
scan_properties
object
service_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create CodeREADr Service

Description

Tool to create a new workflow configuration (service) for scanning tasks. Use after obtaining a valid API key when registering a new Service.

Action Parameters

postback_url
string
scan_properties
object
service_id
string
service_name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete CodeREADr Database

Description

Tool to delete an existing CodeREADr database. Use when you need to remove a database by its ID after confirming you no longer need its data. Example prompt: "Delete database with ID 123e4567-e89b-12d3-a456-426614174000".

Action Parameters

database_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Device

Description

Tool to delete a device. Attempts the REST endpoint first and falls back to the legacy section/action API as needed. Parses JSON, XML, or text heuristically to avoid brittle failures.

Action Parameters

device_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Custom Question

Description

Tool to delete an existing custom question. Attempts the documented REST endpoint first; if unavailable, falls back to the legacy section/action API.

Action Parameters

question_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete CodeREADr Service

Description

Tool to delete an existing CodeREADr service. Use when you need to remove a service by its ID. Example prompt: "Delete service with ID 123e4567-e89b-12d3-a456-426614174000".

Action Parameters

service_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete CodeREADr User

Description

Tool to delete an existing user account. Attempts the REST endpoint first and falls back to the legacy section/action API if needed.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Supported Barcode Types

Description

Tool to list supported barcode types. Use when you need to know which symbologies CodeREADr can scan.

Action Parameters

limit
integer
only_barcode_types
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Manage CodeREADr Response Fields

Description

Tool to create or update response fields returned with scan data. Use when customizing which fields to include in scan payloads.

Action Parameters

fields
arrayRequired
service_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve CodeREADr Databases

Description

Tool to list all validation databases. Use when you need to fetch the configured scan-validation databases in your CodeREADr account after authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Devices

Description

Tool to fetch registered devices. Use when you need to list all devices in your CodeREADr account.

Action Parameters

page
integer
per_page
integer
search
string
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve bulk scan records

Description

Tool to retrieve bulk scan records. Use after specifying filters to fetch scan history in JSON or CSV for reporting.

Action Parameters

end_date
string
return_type
stringDefaults to json
start_date
string
template
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve CodeREADr Services

Description

Tool to list all services. Use when you need to fetch configured services in your CodeREADr account after authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set Admin PIN

Description

Tool to set or update the administrator PIN for Kiosk Mode. Use when updating the global or device/service-specific kiosk admin PIN.

Action Parameters

device_id
string
pin
stringRequired
service_id
integer

Action Response

data
object
error
string
status_code
integerRequired
successful
booleanRequired

Tool Name: Update CodeREADr Question

Description

Tool to update an existing custom question. Use when you need to modify question text or response options after creation. Use after confirming the question_id.

Action Parameters

options
array
question_id
integerRequired
text
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update CodeREADr Service

Description

Tool to update an existing service configuration. Use when you need to change settings of a CodeREADr service by ID.

Action Parameters

action
stringDefaults to update
api_key
stringRequired
auto_next_scan
integer
auto_next_scan_delay
integer
auto_sync
integer
auto_sync_down_delay
integer
auto_sync_down_url
integer
auto_sync_up_delay
integer
auto_sync_up_url
string
block_camera_scan
integer
block_db_search
integer
block_manual_scan
integer
database_id
string
description
string
device_duplicate_value
integer
direct_history_url
string
direct_lookup_url
string
duplicate_value
integer
enableGPS
integer
period_end_date
string
period_end_time
string
period_start_date
string
period_start_time
string
postback_real_time_scans
integer
postback_receiver_only
integer
postback_uploaded_scans
integer
postback_url
string
regex_response_pattern
string
regex_response_replacement
string
regex_scan_pattern
string
regex_scan_replacement
string
section
stringDefaults to services
service_id
integerRequired
service_name
string
symbologies
string
upload_email
string
upload_email_format
string
viewOtherScans
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired