# Orca Scan REST API

> An easy way to add barcode scanning to any system using a REST API.

Orca Scan removes the need to build and maintain barcode scanning functionality yourself. Users scan barcodes using iOS, Android, or dedicated barcode scanners, while your existing system reads and writes the captured data through a simple REST API.

Use the API to integrate barcode scanning with existing software, databases, ERP systems, inventory systems, websites, and custom applications.

Base URL: https://api.orcascan.com/v1

## Authentication

Authentication uses an Orca Scan API key passed as a Bearer token:

    Authorization: Bearer orca_XXXXXXXXXXXXXXXXXXXXXXXXXXX

Get your API key from the REST API guide linked below.

## Important behavior

Successful API responses are wrapped in a top-level `data` property.

Row updates replace the complete row by default. Use `?partial=true` on supported row operations to update only supplied fields.

Use `?withTitles=true` on supported row operations to use field titles instead of internal field keys.

The API is rate limited to 15 requests per second per IP. Rate-limit responses use HTTP 429 and include a `Retry-After` header.

## Capabilities

- Manage barcode tracking sheets
- Define and update fields (columns)
- Create, query, update, and delete rows
- Find rows by barcode
- Perform bulk row and field operations
- Configure outgoing webhooks
- Configure automation triggers
- View sheet and row history
- Manage sheet users and permissions

## Documentation

- [OpenAPI specification](https://api.orcascan.com/v1/openapi.json): Canonical machine-readable API contract including endpoints, request schemas, parameters, authentication, responses, and errors.
- [REST API guide](https://orcascan.com/guides/barcode-scanning-rest-api-f09a21c3.md): Full documentation with examples and implementation guidance.

## Example

List all sheets:

    curl https://api.orcascan.com/v1/sheets \
      -H "Authorization: Bearer orca_XXXXXXXXXXXXXXXXXXXXXXXXXXX"