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

# Companies track

> Track or reactivate a company and request its research

CLI: `adside research companies track`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/research/companies
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/companies:
    post:
      tags:
        - Research
      summary: Companies track
      description: |-
        Track or reactivate a company and request its research

        CLI: `adside research companies track`
      operationId: research.companies.track
      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
              type: object
              properties:
                websiteUrl:
                  type: string
                  format: uri
                collectionIds:
                  type: array
                  items:
                    type: string
                nickname:
                  type: string
                  maxLength: 100
                notes:
                  type: string
                  maxLength: 2000
                priority:
                  type: integer
                  minimum: 1
                  maximum: 5
                classification:
                  type: string
                  enum:
                    - COMPETITOR
                    - INSPIRATION
                    - SELF
                confirmationToken:
                  type: string
              required:
                - websiteUrl
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  trackedCompany:
                    type: object
                    properties:
                      id:
                        type: string
                      workspaceId:
                        type: string
                      companyProfileId:
                        type: string
                      nickname:
                        anyOf:
                          - type: string
                          - type: 'null'
                      notes:
                        anyOf:
                          - type: string
                          - type: 'null'
                      priority:
                        type: integer
                        minimum: 1
                        maximum: 5
                      classification:
                        type: string
                        enum:
                          - COMPETITOR
                          - INSPIRATION
                          - SELF
                      status:
                        type: string
                        enum:
                          - active
                          - paused
                          - archived
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      companyProfile:
                        type: object
                        properties:
                          id:
                            type: string
                          domain:
                            type: string
                          websiteUrl:
                            type: string
                            format: uri
                          companyName:
                            type: string
                          logo:
                            anyOf:
                              - type: string
                                format: uri
                              - type: 'null'
                          icon:
                            anyOf:
                              - type: string
                                format: uri
                              - type: 'null'
                          tagline:
                            anyOf:
                              - type: string
                              - type: 'null'
                          brandColors:
                            maxItems: 10
                            type: array
                            items:
                              type: string
                              pattern: ^#[0-9A-Fa-f]{6}$
                          toneOfVoice:
                            maxItems: 10
                            type: array
                            items:
                              type: string
                              maxLength: 50
                          industry:
                            anyOf:
                              - type: string
                              - type: 'null'
                          vertical:
                            anyOf:
                              - type: string
                              - type: 'null'
                          marketPositioning:
                            anyOf:
                              - type: string
                              - type: 'null'
                          websiteSnapshot:
                            anyOf:
                              - type: string
                                format: uri
                              - type: 'null'
                          websiteMarkdown:
                            anyOf:
                              - type: string
                              - type: 'null'
                          lastScrapedAt:
                            anyOf:
                              - type: string
                              - type: 'null'
                          scrapedVersion:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                        required:
                          - id
                          - domain
                          - websiteUrl
                          - companyName
                          - logo
                          - icon
                          - tagline
                          - brandColors
                          - toneOfVoice
                          - industry
                          - vertical
                          - marketPositioning
                          - websiteSnapshot
                          - websiteMarkdown
                          - lastScrapedAt
                          - scrapedVersion
                          - createdAt
                          - updatedAt
                        additionalProperties: false
                    required:
                      - id
                      - workspaceId
                      - companyProfileId
                      - nickname
                      - notes
                      - priority
                      - classification
                      - status
                      - createdAt
                      - updatedAt
                      - companyProfile
                    additionalProperties: false
                  needsScrape:
                    type: boolean
                  outcome:
                    type: string
                    enum:
                      - already_tracked
                      - reactivated
                      - created
                  enrichmentQueued:
                    type: boolean
                required:
                  - trackedCompany
                  - needsScrape
                  - outcome
                  - enrichmentQueued
                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.