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

# Show Persona



## OpenAPI

````yaml /openapi.json get /api/v1/projects/{project}/personas/{persona}
openapi: 3.1.0
info:
  title: Surfacd Public API
  version: 1.0.0
  description: >-
    Public API for Surfacd. Team-scoped operations live under
    `/api/v1/team/...`; project collections live under `/api/v1/projects`;
    project-scoped operations live under `/api/v1/projects/{project}/...`. All
    endpoints require a Bearer team API key created in Team Settings. The API
    key selects the team for team-level and collection endpoints. Reports
    default to currently monitored, nondeprecated platforms. Explicit platform
    filters can include deprecated or no-longer-monitored platforms with project
    history, provided they remain enabled globally. Admin-disabled platforms are
    excluded; no eligible default platforms means no default answers. Use
    `copilot` for historical standalone Copilot data and `bing_ai_mode` for Bing
    AI Mode; these are separate platforms. Deprecated platforms are not
    available for new monitoring through `/api/v1/platforms`.
servers:
  - url: https://app.surfacd.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Project management endpoints.
  - name: Prompts
    description: Prompt management endpoints.
  - name: Team
    description: Team settings and plan details for the current team.
  - name: Reporting
    description: >-
      Read-only reporting endpoints for projects (brand rankings, mentions,
      visibility, matrix analysis, source data) and single AI answers.
  - name: Reference
    description: Reference data used by create, update, and reporting filters.
  - name: Tags
    description: Project tag management endpoints.
  - name: Reputation
    description: >-
      Read-only reputation analytics for a project: sentiment overview and
      trends, themes, narratives, the AI responses behind them, and the sources
      those responses cite. Requires the Reputation capability on the project's
      team; without it these endpoints return `403`.
  - name: Reports
    description: >-
      The report query endpoint. One `POST` per report entity (`visibility`,
      `sources`, `narratives`) takes dimensions, measures, filters, an optional
      compare window and paging, and returns a dataset any renderer can draw.
      The schema and values endpoints describe what a query accepts. See the
      Reports API guide in the docs for worked examples of every app report.
  - name: Personas
    description: >-
      Project persona management endpoints. A persona is a buyer you want AI to
      recommend you to; a prompt can be asked from one persona's point of view,
      and reporting can be filtered or broken down by persona. Prompts asked
      without a persona are `no_persona` ("No persona") here and in reports, and
      the Baseline in the app. Personas are in beta and available to all teams
      with API access.
paths:
  /api/v1/projects/{project}/personas/{persona}:
    parameters:
      - $ref: '#/components/parameters/ProjectUuid'
      - $ref: '#/components/parameters/PersonaUuid'
    get:
      tags:
        - Personas
      summary: Show Persona
      operationId: v1ProjectsPersonasShow
      responses:
        '200':
          description: Project persona.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectPersona'
        '404':
          description: Project or persona not found in the current team.
components:
  parameters:
    ProjectUuid:
      name: project
      in: path
      required: true
      description: Project UUID.
      schema:
        type: string
        format: uuid
    PersonaUuid:
      name: persona
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Persona UUID.
  schemas:
    ProjectPersona:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
          description: >-
            Short label shown in filters and reports. Unique within the project
            (case-insensitive).
        job_titles:
          type: array
          items:
            type: string
            maxLength: 100
          description: Job titles the persona typically holds.
        seniorities:
          type: array
          items:
            type: string
            maxLength: 100
          description: Seniority levels, e.g. `Director`. Any short label is accepted.
        company_sizes:
          type: array
          items:
            $ref: '#/components/schemas/PersonaCompanySize'
          description: Employee-count bands of the companies the persona works at.
        industries:
          type: array
          items:
            type: string
            maxLength: 100
          description: Industries the persona works in. Any short label is accepted.
        motivators:
          type:
            - string
            - 'null'
          description: >-
            What the persona is trying to achieve and why they look for a
            solution.
        pain_points:
          type:
            - string
            - 'null'
          description: What frustrates the persona today.
        prompts_count:
          type: integer
          description: Number of the project's prompts asked as this persona.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - uuid
        - name
        - job_titles
        - seniorities
        - company_sizes
        - industries
        - motivators
        - pain_points
        - prompts_count
        - created_at
        - updated_at
    PersonaCompanySize:
      type: string
      description: An employee-count band.
      enum:
        - 1-10
        - 11-50
        - 51-200
        - 201-500
        - 501-1000
        - 1001-5000
        - 5001-10000
        - 10000+
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        Team API key created in Team Settings. Use it with URLs for the same
        team.

````

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