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

# Download a sample file

> GET /bulk-operation/sample/{slug}/

Downloads a sample sheet for a QR category, on the **Management API** host (`api.scanova.io`), authenticated with your raw Management API key.

```
GET https://api.scanova.io/bulk-operation/sample/{slug}/
Authorization: 401f7ac837da42b97f613d789819ff93537bee6a
```

<ParamField path="slug" type="string" required>
  The QR category slug, e.g. `vcard`.
</ParamField>

<ParamField query="qrid" type="string">
  For any category except `url`, build the sample from this QR's own field values instead of the generic category template — useful when you want a fill-in sheet shaped like an existing QR.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.scanova.io/bulk-operation/sample/vcard/" \
    -H "Authorization: 401f7ac837da42b97f613d789819ff93537bee6a" \
    -o vcard-sample.csv
  ```
</RequestExample>

The response is a CSV or XLSX file download, not JSON — its columns match what [Bulk-generate QR Codes](/api-reference/management-api/bulk-operation/generate) expects for that category.

## Related

* [Bulk-generate QR Codes](/api-reference/management-api/bulk-operation/generate) — the endpoint this sample sheet feeds.
* [Validate a bulk operation file](/api-reference/management-api/bulk-operation/validate) — check your filled-in sheet before generating.
* [Management API overview](/api-reference/management-api/overview) — the auth scheme and quota rules that apply to this endpoint.


## OpenAPI

````yaml api-reference/openapi/management-api.json GET /bulk-operation/sample/{slug}/
openapi: 3.1.0
info:
  title: Scanova Management API (v2)
  description: >-
    The complete Scanova Management API — every endpoint available at
    api.scanova.io (QR codes, folders, tags, leads, forms, analytics, plans,
    shared users & roles), plus the token-creation and usage-stats endpoints
    used to authenticate against it. Every path and request/response shape below
    was verified live against a real API key and the actual running backend
    (Phase 7, 2026-08-16) — not guessed from reading urls.py alone.
  version: 2.0.0
servers:
  - url: https://api.scanova.io
    description: Management API — QR/folder/tag/lead/form/analytics/plans endpoints
security:
  - apiKeyAuth: []
paths:
  /bulk-operation/sample/{slug}/:
    get:
      summary: Download a sample file
      description: >-
        Downloads a static sample sheet for a QR category, used as the starting
        template for `generate`. Pass `?qrid=` (for any category except `url`)
        to instead build a per-template sample sheet from that QR's own data.
      operationId: getBulkOperationSampleFile
      parameters:
        - name: slug
          in: path
          required: true
          schema:
            type: string
          description: QR category slug, e.g. `vcard`.
        - name: qrid
          in: query
          required: false
          schema:
            type: string
          description: >-
            Build the sample from this QR's own field values instead of the
            generic template.
      responses:
        '200':
          description: Sample file download (CSV or XLSX).
          content:
            text/csv: {}
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Send your Management API key as the raw value of the Authorization
        header — no "Bearer " or "Token " prefix, and no other characters.
        Example: `Authorization: 401f7ac837da42b97f613d789819ff93537bee6a`. A
        header containing more than one space-separated part is rejected
        outright. Requests also require the request's Host header to be the
        management API host (e.g. api.scanova.io) — the same key sent to the
        regular API host will not authenticate.

````