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

# Retrieve a tracking pixel

> Retrieve the complete configuration for one tracking pixel.

`GET /v1/tracking-pixel/{pixel_id}` requires **Tracking pixels: Read** (`tracking_pixels.view`). The response includes `id`, `name`, `type`, `pixel_id`, `head_code`, `body_code`, `links_count`, and timestamps. Provider pixels return a `pixel_id` with both code fields set to `null`. Custom pixels return `pixel_id: null` and their configured code fields. Because custom code is returned, give this permission only to trusted integrations. Unavailable `biq_pxl_...` IDs return `404 resource_not_found`.

## Shared API behavior

Authentication is workspace-scoped; see [Authentication](/docs/api-reference/authentication). Errors use the standard envelope and request IDs described in [Errors](/docs/api-reference/errors), and requests are subject to [Rate limits](/docs/api-reference/rate-limits).


## OpenAPI

````yaml GET /v1/tracking-pixel/{pixel}
openapi: 3.1.0
info:
  title: Biqli API
  version: 1.0.0
  description: Workspace-scoped REST API for Biqli.
servers:
  - url: https://biq.li/api
security:
  - bearerAuth: []
paths:
  /v1/tracking-pixel/{pixel}:
    parameters:
      - $ref: '#/components/parameters/PixelId'
    get:
      tags:
        - Tracking pixels
      summary: Retrieve a tracking pixel
      description: Requires tracking_pixels.view.
      operationId: pixel.show
      responses:
        '200':
          description: Pixel.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixelResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    PixelId:
      name: pixel
      in: path
      required: true
      schema:
        type: string
        pattern: ^biq_pxl_[0-9A-HJKMNP-TV-Z]{26}$
  schemas:
    PixelResponse:
      type: object
      required:
        - pixel
        - status
      properties:
        pixel:
          $ref: '#/components/schemas/Pixel'
        status:
          type: string
          const: success
    Pixel:
      type: object
      additionalProperties: false
      required:
        - id
        - name
        - type
        - pixel_id
        - head_code
        - body_code
        - links_count
      properties:
        id:
          type: string
          pattern: ^biq_pxl_[0-9A-HJKMNP-TV-Z]{26}$
        name:
          type: string
        type:
          type: string
          enum:
            - facebook
            - twitter
            - google-tag-manager
            - google-analytics
            - adwords
            - bing
            - pinterest
            - linkedin
            - quora
            - adroll
            - nexus-segment
            - custom
        pixel_id:
          type:
            - string
            - 'null'
          description: Provider identifier, or null for custom pixels.
        head_code:
          type:
            - string
            - 'null'
          description: Custom head code, or null for provider pixels.
        body_code:
          type:
            - string
            - 'null'
          description: Custom body code, or null for provider pixels.
        links_count:
          type: integer
          minimum: 0
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    ApiError:
      type: object
      required:
        - error
        - request_id
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_token
                - insufficient_scope
                - upgrade_required
                - quota_exceeded
                - resource_not_found
                - domain_taken
                - alias_taken
                - external_id_taken
                - folder_name_taken
                - tag_name_taken
                - pixel_name_taken
                - biolink_name_taken
                - method_not_allowed
                - url_blocked
                - dns_verification_failed
                - validation_error
                - rate_limit_exceeded
                - internal_server_error
            message:
              type: string
            details:
              type: object
              additionalProperties: true
        request_id:
          type: string
          description: Request identifier to include when contacting support.
  responses:
    Unauthorized:
      $ref: '#/components/responses/ApiErrorResponse'
      description: The workspace API key is missing, invalid, or revoked.
    Forbidden:
      $ref: '#/components/responses/ApiErrorResponse'
      description: >-
        The key lacks a required scope, the workspace must upgrade, or its quota
        is exhausted.
    NotFound:
      $ref: '#/components/responses/ApiErrorResponse'
      description: >-
        The requested resource or referenced public ID is unavailable in the
        key's workspace.
    RateLimited:
      description: The workspace exceeded its plan's API rate limit.
      headers:
        RateLimit-Policy:
          description: Current IETF HTTPAPI quota policy as a structured field.
          schema:
            type: string
            example: '"workspace-api";q=1000;w=60'
        RateLimit:
          description: Current IETF HTTPAPI service limit as a structured field.
          schema:
            type: string
            example: '"workspace-api";r=0;t=17'
        Retry-After:
          description: Seconds to wait before retrying the request.
          schema:
            type: integer
            minimum: 0
            example: 17
        X-RateLimit-Limit:
          description: Legacy maximum request count for the current window.
          schema:
            type: integer
            minimum: 1
            example: 1000
        X-RateLimit-Remaining:
          description: Legacy remaining request count.
          schema:
            type: integer
            minimum: 0
            example: 0
        X-RateLimit-Reset:
          description: Legacy reset time as a UTC Unix timestamp.
          schema:
            type: integer
            format: int64
            example: 1788126519
        X-Biq-Request-Id:
          description: Request identifier for support and tracing.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      $ref: '#/components/responses/ApiErrorResponse'
      description: The request failed unexpectedly.
    ApiErrorResponse:
      description: API error.
      headers:
        X-Biq-Request-Id:
          description: Request identifier for support and tracing.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Workspace API key
      description: A workspace API key beginning with biqli_.

````