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

# List a brand's scans

> The brand's scan runs, newest first. Default page size here is 90.



## OpenAPI

````yaml https://agentled.co/api/v1/openapi.json get /brands/{id}/scans
openapi: 3.1.0
info:
  title: agentled API
  version: 1.0.0
  description: >-
    Programmatic access to the agentled AI Search monitor: manage brands and
    prompts, set a brand's measurement location, and read scan results — the
    same data behind the dashboard.


    All requests are authenticated with an API key you mint in the Account tab,
    sent as `Authorization: Bearer agl_live_...`. Every key is scoped to your
    account: you only ever see brands your account belongs to.


    **Base URL:** `https://agentled.co/api/v1`
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: agentled
    url: https://agentled.co
servers:
  - url: https://agentled.co/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Plan
    description: The account's plan and its limits.
  - name: Brands
    description: Brands the account monitors.
  - name: Prompts
    description: The questions asked about a brand each scan.
  - name: Answers
    description: Per-scan answer history for a prompt.
  - name: Metrics
    description: A brand's AI-visibility metrics.
  - name: Scans
    description: Scan runs.
  - name: Geo
    description: Valid country/city values for a brand's location.
paths:
  /brands/{id}/scans:
    get:
      tags:
        - Scans
      summary: List a brand's scans
      description: The brand's scan runs, newest first. Default page size here is 90.
      operationId: listScans
      parameters:
        - name: id
          in: path
          required: true
          description: Brand id (UUID). A value that is not a UUID returns 404.
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          required: false
          description: Page size, 1–200. Defaults to 90 for this endpoint.
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 90
        - name: offset
          in: query
          required: false
          description: Rows to skip (0 or more).
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: A page of scan runs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    ScanList:
      type: object
      required:
        - scans
        - pagination
      properties:
        scans:
          type: array
          items:
            $ref: '#/components/schemas/Scan'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Scan:
      type: object
      properties:
        id:
          type: string
          format: uuid
        brandId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
        trigger:
          type: string
          enum:
            - onboarding
            - scheduled
            - manual
          description: What started the run.
        model:
          type:
            - string
            - 'null'
        promptsAttempted:
          type: integer
        promptsCompleted:
          type: integer
        error:
          type:
            - string
            - 'null'
        startedAt:
          type:
            - string
            - 'null'
          format: date-time
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    Pagination:
      type: object
      description: Offset pagination. `hasMore` tells you whether another page exists.
      required:
        - limit
        - offset
        - hasMore
      properties:
        limit:
          type: integer
          description: The effective (clamped) page size used.
        offset:
          type: integer
          description: The offset used.
        hasMore:
          type: boolean
          description: True if more rows exist past this page.
    Error:
      type: object
      description: Every error has this shape. Branch on the stable `error.code`.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable code.
              enum:
                - unauthorized
                - not_found
                - bad_request
                - limit_reached
                - server_error
            message:
              type: string
              description: Human-readable explanation.
            upgradeUrl:
              type: string
              description: >-
                Present only when `code` is `limit_reached`: where to upgrade
                the plan.
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The resource does not exist, or your account cannot see it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Something went wrong. Retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the Account tab, sent as `Authorization: Bearer
        agl_live_...`. Keys are secret; store them server-side.

````