# CM.com Scanning API

**Canonical:** https://apis.io/apis/cm-com/cm-com-scanning-api/  
**Provider:** CM.com — https://apis.io/providers/cm-com/  
**Base URL:** https://api.cm.com  
**Documentation:** https://docs.cm.com/conversational-ai/v1/api-reference

CM.com Scanning API is one of 167 APIs that [CM.com](https://apis.io/providers/cm-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 144 JSON Schema definitions. Tagged areas include Scanning. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 144 JSON Schemas.

Scan API for barcode scanning, validate, check-in, and check-out operations

## Operations (54)

| Method | Path | Summary |
|---|---|---|
| GET | `/entrance/v1.0/scan/plans` | List entrance plans for the current user |
| GET | `/entrance/v1.0/scan/plans/{entrancePlanUuid}` | Get an entrance plan by UUID |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/events` | List events for an entrance plan |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/rules` | List rules for an entrance plan |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/venues` | List venues for an entrance plan |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/constraints` | List constraints for an entrance plan |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/products` | List products for an entrance plan |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/tickets` | List tickets for an entrance plan |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/validate` | Validate a scan barcode |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/checkin` | Check in a barcode |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/order/preview` | Preview checking in the entire order for a scanned barcode |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/order/checkin` | Check in the selected tickets of an order |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/checkin/confirm` | Confirm a pending check-in |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/checkin/deny` | Deny a pending check-in |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/checkout` | Check out a barcode |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/logs` | List scan logs for an entrance plan (deprecated) |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/sync` | Sync offline scans |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/sync` | Get scan logs since a given timestamp |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/sync/tickets` | Get tickets updated since a given timestamp |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/download` | Download initial sync file for entrance plan |
| POST | `/entrance/v1.0/scan/{entrancePlanUuid}/callback/{ulid}` | Trigger a scan callback |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/analytics/scan-progress` | Get scan progress for an entrance plan |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/analytics/widgets` | Get analytics widget data for an entrance plan |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/analytics/scans-by-product` | Get scan counts grouped by product (only products with scans) |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/analytics/by-product` | Get scan counts grouped by product (all products, zero-scan rows padded) |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/analytics/venue/{venueUuid}` | Get scan overview for a venue |
| GET | `/entrance/v1.0/scan/{entrancePlanUuid}/analytics/logs` | List scan logs for an entrance plan |
| GET | `/entrance/v2.0/scan/plans` | List entrance plans for the current user |
| GET | `/entrance/v2.0/scan/plans/{entrancePlanUuid}` | Get an entrance plan by UUID |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/events` | List events for an entrance plan |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/rules` | List rules for an entrance plan |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/venues` | List venues for an entrance plan |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/constraints` | List constraints for an entrance plan |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/products` | List products for an entrance plan |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/tickets` | List tickets for an entrance plan |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/validate` | Validate a scan barcode |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/checkin` | Check in a barcode |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/order/preview` | Preview checking in the entire order for a scanned barcode |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/order/checkin` | Check in the selected tickets of an order |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/checkin/confirm` | Confirm a pending check-in |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/checkin/deny` | Deny a pending check-in |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/checkout` | Check out a barcode |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/logs` | List scan logs for an entrance plan (deprecated) |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/sync` | Sync offline scans |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/sync` | Get scan logs since a given timestamp |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/sync/tickets` | Get tickets updated since a given timestamp |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/download` | Download initial sync file for entrance plan |
| POST | `/entrance/v2.0/scan/{entrancePlanUuid}/callback/{ulid}` | Trigger a scan callback |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/analytics/scan-progress` | Get scan progress for an entrance plan |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/analytics/widgets` | Get analytics widget data for an entrance plan |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/analytics/scans-by-product` | Get scan counts grouped by product (only products with scans) |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/analytics/by-product` | Get scan counts grouped by product (all products, zero-scan rows padded) |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/analytics/venue/{venueUuid}` | Get scan overview for a venue |
| GET | `/entrance/v2.0/scan/{entrancePlanUuid}/analytics/logs` | List scan logs for an entrance plan |

## Machine-readable artifacts (198)

- **OpenAPI** — https://artifacts.apis.io/cm-com/openapi/cm-com-scanning-api-openapi.yml
- **Documentation** — https://docs.cm.com/conversational-ai/v1/api-reference
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-health-response-schema.json
- **Documentation** — https://docs.cm.com/conversational-router/v1/api-reference
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-connect-custom-schema.json
- **Documentation** — https://docs.cm.com/conversational-router/v2/api-reference
- **Documentation** — https://docs.cm.com/customer-engagement/v1/api-reference
- **Documentation** — https://docs.cm.com/email-gateway-api/v1/api-reference
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-gateway-gateway-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-configuration-email-inbound-webhook-update-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-configuration-email-inbound-webhook-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-suppression-email-unsubscribe-filters-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-configuration-email-inbound-webhook-controller-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-suppression-unsubscribe-request-dto-schema.json
- **Documentation** — https://docs.cm.com/halo/analytics/v1/api-reference
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-conversation-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-create-feedback-score-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-feedback-score-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-conversations-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-conversation-item-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-metrics-data-schema.json
- **Documentation** — https://docs.cm.com/halo/core/v1/api-reference
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-handover-input-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-profile-view-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-culture-view-schema.json
- **Documentation** — https://docs.cm.com/live/entrance-management/v1/api-reference
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-rule-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-rule-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-create-rule-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-update-rule-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-ticket-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-create-ticket-dto-schema.json
- **Documentation** — https://docs.cm.com/live/entrance-management/v2/api-reference
- **Documentation** — https://docs.cm.com/live/event-apps/v1/api-reference
- **Documentation** — https://docs.cm.com/live/event-ticketing/v1/api-reference
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-handler-view-customer-product-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-handler-view-event-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-event-create-event-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-handler-product-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/cm-com/json-schema/cm-com-handler-view-order-response-schema.json
- …and 158 more, listed in full on the page.

## Other CM.com APIs (12)

- [CM.com Add Contact API](https://apis.io/apis/cm-com/cm-com-addcontact-api/)
- [CM.com Analytics API](https://apis.io/apis/cm-com/cm-com-analytics-api/)
- [CM.com Analytics - Filter Presets API](https://apis.io/apis/cm-com/cm-com-analytics-filter-presets-api/)
- [CM.com Analytics - Report Subscriptions API](https://apis.io/apis/cm-com/cm-com-analytics-report-subscriptions-api/)
- [CM.com API Settings API](https://apis.io/apis/cm-com/cm-com-apisettings-api/)
- [CM.com Apple Business Chat API](https://apis.io/apis/cm-com/cm-com-applebusinesschat-api/)
- [CM.com Archive API](https://apis.io/apis/cm-com/cm-com-archive-api/)
- [CM.com Auth API](https://apis.io/apis/cm-com/cm-com-auth-api/)
- [CM.com Authentication API](https://apis.io/apis/cm-com/cm-com-authentication-api/)
- [CM.com Authorization API](https://apis.io/apis/cm-com/cm-com-authorization-api/)
- [CM.com Bancontact API](https://apis.io/apis/cm-com/cm-com-bancontact-api/)
- [CM.com Bank Transfer API](https://apis.io/apis/cm-com/cm-com-banktransfer-api/)

## Tags

Scanning

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cm-com/cm-com-scanning-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cm-com/.