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

# Ads fetch

> Read cached public ads or start an asynchronous brand scrape

CLI: `adside research ads fetch`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/research/ads
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/research/ads:
    post:
      tags:
        - Research
      summary: Ads fetch
      description: |-
        Read cached public ads or start an asynchronous brand scrape

        CLI: `adside research ads fetch`
      operationId: research.ads.fetch
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              oneOf:
                - type: object
                  properties:
                    limit:
                      type: integer
                      minimum: 1
                      maximum: 500
                    forceRefresh:
                      type: boolean
                    trackedCompanyId:
                      type: string
                    channel:
                      type: string
                      const: META
                    adlibraryUrl:
                      type: string
                      minLength: 1
                  required:
                    - channel
                    - adlibraryUrl
                - type: object
                  properties:
                    limit:
                      type: integer
                      minimum: 1
                      maximum: 500
                    forceRefresh:
                      type: boolean
                    trackedCompanyId:
                      type: string
                    channel:
                      type: string
                      const: GOOGLE
                    searchTerm:
                      type: string
                      minLength: 1
                    domain:
                      type: string
                      minLength: 1
                  required:
                    - channel
                    - searchTerm
                    - domain
                - type: object
                  properties:
                    limit:
                      type: integer
                      minimum: 1
                      maximum: 500
                    forceRefresh:
                      type: boolean
                    trackedCompanyId:
                      type: string
                    channel:
                      type: string
                      const: LINKEDIN
                    companyName:
                      type: string
                      minLength: 1
                  required:
                    - channel
                    - companyName
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                anyOf:
                  - type: object
                    properties:
                      ads:
                        type: array
                        items:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties: {}
                      totalAds:
                        anyOf:
                          - type: number
                          - type: 'null'
                      cached:
                        type: boolean
                        const: true
                      cachedAt:
                        type: string
                      newAdIds: {}
                    required:
                      - ads
                      - totalAds
                      - cached
                      - cachedAt
                    additionalProperties: false
                  - type: object
                    properties:
                      runId:
                        type: string
                      status:
                        type: string
                    required:
                      - runId
                      - status
                    additionalProperties: false
        '202':
          description: Accepted asynchronous operation
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                anyOf:
                  - type: object
                    properties:
                      ads:
                        type: array
                        items:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties: {}
                      totalAds:
                        anyOf:
                          - type: number
                          - type: 'null'
                      cached:
                        type: boolean
                        const: true
                      cachedAt:
                        type: string
                      newAdIds: {}
                    required:
                      - ads
                      - totalAds
                      - cached
                      - cachedAt
                    additionalProperties: false
                  - type: object
                    properties:
                      runId:
                        type: string
                      status:
                        type: string
                    required:
                      - runId
                      - status
                    additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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