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

# API reference

> Review Incarts API endpoints, request fields, and responses

Use the endpoint reference to build link and QR code integrations with the Incarts API.

<Info>
  The current API supports shoppable link creation and retrieval, plus QR code creation for links.
</Info>

## Authentication

Authenticated requests use the `X-Incarts-API-Key` header.

```bash theme={null}
curl "$INCARTS_API_BASE_URL/v1/links/lnk_01JZ4TDK6A0NV2HG6R3Q7E28Y9" \
  --header "X-Incarts-API-Key: $INCARTS_API_KEY"
```

## Endpoints

<CardGroup cols={2}>
  <Card title="Check service health" icon="heart-pulse" href="/api-reference/endpoint/get-health">
    Confirm that the API service is available.
  </Card>

  <Card title="Check service readiness" icon="signal" href="/api-reference/endpoint/get-readiness">
    Confirm that the API can accept traffic.
  </Card>

  <Card title="Create a shoppable link" icon="link" href="/api-reference/endpoint/create-link">
    Generate a short link and, when available, a default QR code.
  </Card>

  <Card title="Find supported retailers" icon="store" href="/api-reference/endpoint/list-retailers">
    Discover Instacart retailer routing values.
  </Card>

  <Card title="Get a shoppable link" icon="magnifying-glass" href="/api-reference/endpoint/get-link">
    Retrieve an existing link by ID.
  </Card>

  <Card title="Create a QR code" icon="qrcode" href="/api-reference/endpoint/create-qr-code-for-link">
    Create a named QR code for a shoppable link.
  </Card>
</CardGroup>