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

# List

> List the workspace's characters: the people and mascots that media generation keeps the same

CLI: `adside characters list`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/characters
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}/characters:
    get:
      tags:
        - Characters
      summary: List
      description: >-
        List the workspace's characters: the people and mascots that media
        generation keeps the same


        CLI: `adside characters list`
      operationId: characters.list
      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:
                  characters:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        handle:
                          type: string
                        name:
                          type: string
                        kind:
                          type: string
                          enum:
                            - ai_person
                            - real_person
                            - mascot
                        identityNotes:
                          anyOf:
                            - type: string
                            - type: 'null'
                        voiceId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        consentConfirmedAt:
                          anyOf:
                            - type: string
                            - type: 'null'
                        references:
                          type: array
                          items:
                            type: object
                            properties:
                              assetId:
                                type: string
                              url:
                                type: string
                              mimeType:
                                type: string
                              width:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                              height:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                            required:
                              - assetId
                              - url
                              - mimeType
                              - width
                              - height
                            additionalProperties: false
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                        - id
                        - handle
                        - name
                        - kind
                        - identityNotes
                        - voiceId
                        - consentConfirmedAt
                        - references
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                required:
                  - characters
                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.