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

# Get badge scan

> Get a trade show badge scan: who was scanned, at which show and when, the customer or company it is linked to, and the sales reps notified about it. Fetch the scan named by a `badge_scan.created` or `badge_scan.updated` webhook with this; after `badge_scan.deleted` it returns `404`.



## OpenAPI

````yaml get /v1/badge-scans/{id}
openapi: 3.1.0
info:
  description: Client-facing Open APIs for WizCommerce
  title: WizCommerce Open API's
  termsOfService: https://wizcommerce.com/terms/
  contact:
    name: Tech Support
    url: https://help.wizcommerce.com/
    email: tech@wizcommerce.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: '1.0'
servers:
  - url: https://api.wizcommerce.com
    description: Production BaseURL
  - url: https://api-staging.sourcerer.tech
    description: Staging BaseURL
security: []
paths:
  /v1/badge-scans/{id}:
    get:
      tags:
        - Badge Scans
      summary: Get badge scan
      description: >-
        Get a trade show badge scan: who was scanned, at which show and when,
        the customer or company it is linked to, and the sales reps notified
        about it. Fetch the scan named by a `badge_scan.created` or
        `badge_scan.updated` webhook with this; after `badge_scan.deleted` it
        returns `404`.
      parameters:
        - description: Badge scan ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dtos.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/dtos.BadgeScanResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    dtos.SuccessResponse:
      type: object
      properties:
        data:
          x-order: '1'
    dtos.BadgeScanResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 9b2d6c1e-4f3a-4b7e-8c5d-1a2b3c4d5e6f
        badge_id:
          description: The market's badge number; null for a scan typed in by hand.
          type: string
          x-order: '2'
          example: '1048576'
        trade_show:
          allOf:
            - $ref: '#/components/schemas/dtos.BadgeScanTradeShowResponse'
          x-order: '3'
        first_name:
          type: string
          x-order: '4'
          example: Ada
        last_name:
          type: string
          x-order: '5'
          example: Lovelace
        title:
          type: string
          x-order: '6'
          example: Owner
        email:
          type: string
          x-order: '7'
          example: ada@acmeinteriors.com
        phone:
          type: string
          x-order: '8'
          example: '+13365550100'
        company_name:
          type: string
          x-order: '9'
          example: Acme Interiors
        website:
          type: string
          x-order: '10'
          example: https://acmeinteriors.com
        address:
          allOf:
            - $ref: '#/components/schemas/dtos.BadgeScanAddressResponse'
          x-order: '11'
        customer_id:
          description: >-
            The customer the scan was linked to; null until a rep links it.
            Fetch it with Get Customer.
          type: string
          x-order: '12'
          example: 4bd02cd3-06d2-498a-9749-b4f87faeccd7
        company_id:
          description: >-
            The CRM company the scan was linked to; null until a rep links it.
            Fetch it with Get Company.
          type: string
          x-order: '13'
          example: 7c1e2d3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f
        linked_as:
          description: >-
            Whether the rep created the customer or company from the scan, or
            linked one that already existed; null until linked.
          type: string
          enum:
            - new_customer
            - existing_customer
            - new_company
            - existing_company
          x-order: '14'
          example: new_customer
        notified_sales_reps:
          description: >-
            Reps Wiz notified about the scan. Notifications go out shortly after
            the scan, so this can still be empty when badge_scan.created
            arrives; each later notification sends badge_scan.updated.
          type: array
          items:
            $ref: '#/components/schemas/dtos.BadgeScanNotifiedRepResponse'
          x-order: '15'
        created_at:
          description: When the badge was scanned.
          type: string
          x-order: '16'
          example: '2026-10-18T15:42:10Z'
        updated_at:
          type: string
          x-order: '17'
          example: '2026-10-18T15:50:02Z'
    errors.HttpError:
      type: object
      properties:
        code:
          type: string
          x-order: '1'
        message:
          type: string
          x-order: '2'
        details:
          type: array
          items:
            $ref: '#/components/schemas/errors.HttpErrorDetails'
          x-order: '3'
    dtos.BadgeScanTradeShowResponse:
      type: object
      properties:
        name:
          type: string
          x-order: '1'
          example: High Point Market
        code:
          description: The show's code in the market's badge system.
          type: string
          x-order: '2'
          example: HPMF26
    dtos.BadgeScanAddressResponse:
      type: object
      properties:
        address_line_1:
          type: string
          x-order: '1'
          example: 101 S Main St
        address_line_2:
          type: string
          x-order: '2'
          example: Suite 200
        city:
          type: string
          x-order: '3'
          example: High Point
        state:
          type: string
          x-order: '4'
          example: NC
        zip_code:
          type: string
          x-order: '5'
          example: '27260'
        country:
          type: string
          x-order: '6'
          example: US
    dtos.BadgeScanNotifiedRepResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        email:
          type: string
          x-order: '2'
          example: user@example.com
        notified_at:
          description: The latest time Wiz notified this rep about the scan.
          type: string
          x-order: '3'
          example: '2026-10-18T15:42:30Z'
    errors.HttpErrorDetails:
      type: object
      properties:
        field:
          type: string
          x-order: '1'
        reason:
          type: string
          x-order: '2'
  securitySchemes:
    ApiKeyAuth:
      description: API Key for authentication
      type: apiKey
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.