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

# Details

> Read the default brand identity, products and capped website evidence

CLI: `adside brands details`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/brand-details
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}/brand-details:
    get:
      tags:
        - Brands
      summary: Details
      description: |-
        Read the default brand identity, products and capped website evidence

        CLI: `adside brands details`
      operationId: brands.details
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  brand:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                          companyName:
                            type: string
                          tagline:
                            anyOf:
                              - type: string
                              - type: 'null'
                          logoUrl:
                            anyOf:
                              - type: string
                              - type: 'null'
                          iconUrl:
                            anyOf:
                              - type: string
                              - type: 'null'
                          brandColors:
                            type: array
                            items:
                              type: string
                          toneOfVoice:
                            type: array
                            items:
                              type: string
                          marketPositioning:
                            anyOf:
                              - type: string
                              - type: 'null'
                          industry:
                            anyOf:
                              - type: string
                              - type: 'null'
                          vertical:
                            anyOf:
                              - type: string
                              - type: 'null'
                          websiteUrl:
                            anyOf:
                              - type: string
                              - type: 'null'
                          products:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                description:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                imageUrls:
                                  type: array
                                  items:
                                    type: string
                              required:
                                - id
                                - name
                                - description
                                - imageUrls
                              additionalProperties: false
                          evidence:
                            anyOf:
                              - type: object
                                properties:
                                  productFeatures:
                                    default: []
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        featureName:
                                          type: string
                                          minLength: 1
                                          maxLength: 200
                                        description:
                                          type: string
                                          minLength: 1
                                          maxLength: 1500
                                        citation:
                                          anyOf:
                                            - type: string
                                              format: uri
                                            - type: 'null'
                                        imageUrl:
                                          anyOf:
                                            - type: string
                                              format: uri
                                            - type: 'null'
                                      required:
                                        - featureName
                                        - description
                                      additionalProperties: false
                                  useCases:
                                    default: []
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        title:
                                          type: string
                                          minLength: 1
                                          maxLength: 200
                                        description:
                                          type: string
                                          minLength: 1
                                          maxLength: 1500
                                        citation:
                                          anyOf:
                                            - type: string
                                              format: uri
                                            - type: 'null'
                                      required:
                                        - title
                                        - description
                                      additionalProperties: false
                                  testimonials:
                                    default: []
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        quote:
                                          type: string
                                          minLength: 1
                                          maxLength: 2000
                                        customerName:
                                          type: string
                                          minLength: 1
                                          maxLength: 200
                                        customerTitle:
                                          anyOf:
                                            - type: string
                                              maxLength: 200
                                            - type: 'null'
                                        company:
                                          anyOf:
                                            - type: string
                                              maxLength: 200
                                            - type: 'null'
                                        citation:
                                          anyOf:
                                            - type: string
                                              format: uri
                                            - type: 'null'
                                      required:
                                        - quote
                                        - customerName
                                      additionalProperties: false
                                  caseStudies:
                                    default: []
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        title:
                                          type: string
                                          minLength: 1
                                          maxLength: 200
                                        summary:
                                          type: string
                                          minLength: 1
                                          maxLength: 2500
                                        url:
                                          anyOf:
                                            - type: string
                                              format: uri
                                            - type: 'null'
                                        citation:
                                          anyOf:
                                            - type: string
                                              format: uri
                                            - type: 'null'
                                      required:
                                        - title
                                        - summary
                                      additionalProperties: false
                                  extractedAt:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - productFeatures
                                  - useCases
                                  - testimonials
                                  - caseStudies
                                  - extractedAt
                                additionalProperties: false
                              - type: 'null'
                        required:
                          - id
                          - companyName
                          - tagline
                          - logoUrl
                          - iconUrl
                          - brandColors
                          - toneOfVoice
                          - marketPositioning
                          - industry
                          - vertical
                          - websiteUrl
                          - products
                          - evidence
                        additionalProperties: false
                      - type: 'null'
                required:
                  - brand
                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.