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

# List signals

> Returns non-dismissed signals for the workspace, most-recent first.

**Scope:** `read:signals`



## OpenAPI

````yaml /openapi.json get /signals
openapi: 3.1.0
info:
  title: GainTrace API
  version: 1.0.0
  description: >-
    The GainTrace REST API (v1). Read your customer data and push product-usage
    events, metric events, and signals into GainTrace.


    All endpoints are authenticated with a Bearer API key and scoped to a single
    workspace.
servers:
  - url: https://app.gaintrace.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Companies
    description: Read and manage canonical company records.
  - name: Signals
    description: Read, create, and manage buyer / risk signals.
  - name: Ingest
    description: Push product-usage and metric events into GainTrace.
  - name: Contacts
    description: Read and manage the people on an account.
  - name: Webhooks
    description: Subscribe to workspace events with signed, retried delivery.
paths:
  /signals:
    get:
      tags:
        - Signals
      summary: List signals
      description: |-
        Returns non-dismissed signals for the workspace, most-recent first.

        **Scope:** `read:signals`
      operationId: listSignals
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: A page of signals.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SignalListItem'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    limit:
      name: limit
      in: query
      description: Max rows to return. Default 50, max 100.
      schema:
        type: integer
        default: 50
        maximum: 100
        minimum: 1
    offset:
      name: offset
      in: query
      description: Rows to skip (pagination).
      schema:
        type: integer
        default: 0
        minimum: 0
  schemas:
    SignalListItem:
      type: object
      description: >-
        Subset returned by the list endpoint. GET /signals/{id} returns the full
        Signal.
      properties:
        id:
          type: string
          format: uuid
        accountId:
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/SignalType'
        severity:
          $ref: '#/components/schemas/SignalSeverity'
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        occurredAt:
          type: string
          format: date-time
    Meta:
      type: object
      properties:
        limit:
          type: integer
        offset:
          type: integer
        count:
          type: integer
          description: Number of rows in this page.
    SignalType:
      type: string
      enum:
        - usage_drop
        - usage_spike
        - feature_adoption
        - support_ticket
        - payment_failed
        - expansion_signal
        - nps_response
        - contract_renewal
        - login_inactive
        - champion_left
    SignalSeverity:
      type: string
      enum:
        - info
        - warning
        - critical
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable, safe error message.
        detail:
          type: string
        code:
          type: string
      required:
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Insufficient scope, or API v1 is not enabled for the workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Per-key rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer API key. Secret server keys start with `gt_live_`; client-safe
        browser keys start with `gt_pub_` (write-only, origin-pinned). Create
        and scope keys in Settings → API Keys.

````