> ## 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.

# Get brand signal

> Retrieve one signal for a product the authenticated brand member's organization owns and has claimed. A signal on an unowned or unclaimed product, or one that does not exist, reads as 404 (no existence oracle).



## OpenAPI

````yaml /openapi/openapi-signals.json get /signals/api/v1/brand/signals/{signal_id}/
openapi: 3.1.0
info:
  title: Signals API
  version: 1.0.0
  description: >
    Private product feedback signals — consumer submission/retrieval and the
    brand inbox. A one-way pipe: capture and disclose, never relay. No content
    analysis, no hosted visual media.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Signals
    description: Consumer-facing signal submission, retrieval, edit, and revoke.
  - name: Brand Signals
    description: Brand inbox — list and detail of signals on owned-and-claimed products.
  - name: Signal Review
    description: >-
      Internal-review (staff-only) abuse queue and suppress/ban actions
      (C-3316).
  - name: Adverse Reports
    description: >-
      Typed consumer harm reporting (C-3908) — consumer filing with a reference
      receipt and prefilled regulator handoff, plus the brand inbox and
      lot-level early-warning alerts.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /signals/api/v1/brand/signals/{signal_id}/:
    get:
      tags:
        - Brand Signals
      summary: Get brand signal
      description: >-
        Retrieve one signal for a product the authenticated brand member's
        organization owns and has claimed. A signal on an unowned or unclaimed
        product, or one that does not exist, reads as 404 (no existence oracle).
      operationId: apps_signals_api_brand_get_brand_signal_endpoint
      parameters:
        - in: path
          name: signal_id
          schema:
            description: Public short-UUID id of the signal.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Signal Id
            type: string
          required: true
          description: Public short-UUID id of the signal.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandSignalOut'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - SessionAuth: []
components:
  schemas:
    BrandSignalOut:
      description: >-
        A signal as a *brand member* sees it (ownership + claim scoped).


        Same code-not-label contract as :class:`SignalOut`. ``contact_email`` is

        present **only** when the consumer consented and a verified address is
        still

        attached (C-3310 consent + verification gate); otherwise it is null.
        Internal

        consumer-account details beyond the consented contact email are never
        exposed.
      examples:
        - batch: LOT-2026-04
          body: The seal was broken when I opened it.
          category: quality_issue
          contact_consent: true
          contact_email: shopper@example.com
          created: '2026-06-19T14:30:00Z'
          gtin: '00012345678905'
          has_voice: false
          id: a1b2c3d4e5f6
          is_flagged: false
          sentiment: negative
      properties:
        id:
          description: Public short-UUID identifier of the signal.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        gtin:
          description: >-
            GTIN of the product this signal is about (the product's GTIN-14
            string).
          title: Gtin
          type: string
        batch:
          anyOf:
            - type: string
            - type: 'null'
          description: Batch/lot identifier (GS1 AI 10) carried from the scan, or null.
          title: Batch
        serial:
          anyOf:
            - type: string
            - type: 'null'
          description: Serialized-unit context carried from the scan, or null.
          title: Serial
        category:
          description: >-
            Consumer-picked category as a stable code (e.g. ``quality_issue``).
            Never a translated label.
          title: Category
          type: string
        sentiment:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Optional consumer-declared sentiment code (``positive`` /
            ``neutral`` / ``negative``), or null.
          title: Sentiment
        body:
          description: >-
            Freeform feedback text the consumer wrote (may be empty for
            voice-only signals).
          title: Body
          type: string
        has_voice:
          description: True when a voice capture session backs this signal.
          title: Has Voice
          type: boolean
        contact_consent:
          description: Whether the consumer opted in to be contacted about this feedback.
          title: Contact Consent
          type: boolean
        contact_email:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The consumer's verified contact email — present ONLY when
            ``contact_consent`` is true AND a verified address is still
            attached. Null in every other case (no consent, or the address was
            removed / lost verification). Use it in your own email; Closient
            does not relay replies.
          title: Contact Email
        is_flagged:
          description: >-
            True when the text-hygiene heuristic flagged this signal's content
            (profanity/abuse). A flag is advisory — the signal is shown
            regardless; it never blocks submission. Use it to triage.
          title: Is Flagged
          type: boolean
        flag_reason:
          anyOf:
            - $ref: '#/components/schemas/FlagReasonEnum'
            - type: 'null'
          description: >-
            Stable code describing why the signal was flagged (e.g.
            ``profanity``), or null when not flagged. A code, never a translated
            label.
        created:
          description: ISO-8601 timestamp the signal was submitted.
          format: date-time
          title: Created
          type: string
      required:
        - id
        - gtin
        - category
        - body
        - has_voice
        - contact_consent
        - is_flagged
        - created
      title: BrandSignalOut
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
    FlagReasonEnum:
      description: >-
        Why the text-hygiene heuristic flagged a signal (C-3316).


        Mirrors the stable flag codes in :mod:`apps.signals.services.hygiene`

        (``FLAG_*``). Null on the wire when the signal is not flagged. A code,
        never

        a translated label.
      enum:
        - profanity
      title: FlagReasonEnum
      type: string
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    SessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````