> ## Documentation Index
> Fetch the complete documentation index at: https://docs.closient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Interactive documentation for all Closient APIs.

Closient provides 18 domain-specific APIs. Each has its own OpenAPI specification and interactive playground below.

## APIs

<CardGroup cols={3}>
  <Card title="Account" icon="user" href="/api-reference/account/organizations/list-all-organizations">
    Users, organizations, memberships, API keys. RBAC with Owner, Manager, Billing, and Editor roles.
  </Card>

  <Card title="Products" icon="barcode" href="/api-reference/products/products/list-claimed-products">
    GTIN-based product catalog. Supports GTIN-8/12/13/14 with automatic normalization to GTIN-14. Includes data provenance, confidence scores, and GPC classification.
  </Card>

  <Card title="Brands" icon="tag" href="/api-reference/brands/brands/list-brands">
    Brand ownership, claiming, and management. Brands are linked to organizations and products.
  </Card>

  <Card title="Locations" icon="location-dot" href="/api-reference/locations/store-locator-public/find-nearby-locations">
    Physical store and service locations with PostGIS coordinates. Used for distance-based search ranking.
  </Card>

  <Card title="Retailers" icon="store" href="/api-reference/retailers/retailers/list-retailers">
    Offers, inventory, pricing, and retailer data. Includes regional overrides and inventory confidence levels.
  </Card>

  <Card title="Search" icon="magnifying-glass" href="/api-reference/search/search/create-a-new-search-session">
    Hybrid search with semantic embeddings (1024-dim), lexical matching, and geographic proximity. Conversational sessions with constraint accumulation.
  </Card>

  <Card title="GS1 Digital Link" icon="link" href="/api-reference/resolver/resolver/list-resolution-rules">
    GTIN resolution via Digital Link URIs. Configurable rules with scope hierarchy, time-based routing, and custom destinations.
  </Card>

  <Card title="EPCIS 2.0" icon="route" href="/api-reference/epcis/epcis-2-0/capture-epcis-events">
    Supply chain event capture and query per ISO/IEC 19987:2024. Five event types with full CBV 2.0 vocabulary.
  </Card>

  <Card title="Integrations" icon="plug" href="/api-reference/integrations/webhook-endpoints/create-a-webhook-endpoint">
    POS connections (Shopify, Square, Clover, Lightspeed) and webhook management with signed payloads and delivery tracking.
  </Card>

  <Card title="Billing" icon="credit-card" href="/api-reference/billing/billing/create-checkout-session">
    Stripe-based subscriptions, resolver tiers (Free/Business), and usage metering for API calls, lookups, and webhook deliveries.
  </Card>

  <Card title="Scanner" icon="camera" href="/api-reference/scanner/scanner-sessions/create-a-scan-session">
    Barcode and product image scanning. Supports barcode, image, and manual capture modes with vision extraction proposals.
  </Card>

  <Card title="Compliance" icon="shield-check" href="/api-reference/compliance/compliance/list-product-recalls">
    Product recalls, safety notices, and supply chain traceability.
  </Card>

  <Card title="Certifications" icon="certificate" href="/api-reference/certifications/certifications/list-product-certifications">
    Product certification management and verification.
  </Card>

  <Card title="Sustainability" icon="leaf" href="/api-reference/sustainability/sustainability/get-product-sustainability-data">
    Sustainability data, certifications, and environmental tracking.
  </Card>

  <Card title="Notifications" icon="bell" href="/api-reference/notifications/notifications/list-notification-channels">
    Multi-channel notification delivery (email, Slack, SMS).
  </Card>

  <Card title="Advertising" icon="bullhorn" href="/api-reference/advertising/ads/record-ad-click">
    Ad campaigns, impressions, revenue share, and reporting.
  </Card>

  <Card title="Dashboard" icon="chart-line" href="/api-reference/dashboard/stats/get-dashboard-statistics">
    Analytics, performance snapshots, and observability data.
  </Card>

  <Card title="Content" icon="file-lines" href="/api-reference/content/content/check-product-data-readiness">
    Product readiness checks and content management.
  </Card>
</CardGroup>

## Common Conventions

See [Authentication](/authentication), [Rate Limits](/rate-limits), and [Errors](/errors) for shared patterns.

| Convention | Details                                                   |
| ---------- | --------------------------------------------------------- |
| Base URL   | `https://www.closient.com`                                |
| Auth       | `X-API-Key: <prefix>_<body>_<checksum>`                   |
| Rate limit | 300/min, 10,000/day per key (configurable)                |
| Pagination | `?page=1&page_size=25` (max 100)                          |
| Errors     | `{ "error": { "code", "message", "status", "details" } }` |
| IDs        | nanoid: 12 chars, alphabet `aceghjkpqrtwxy346789`         |
| Timestamps | ISO 8601 UTC                                              |