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

# List Projects

> Returns paginated projects for the current team. Excludes archived projects by default; pass `include_archived=1` to include them.



## OpenAPI

````yaml /openapi.json get /api/v1/projects
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.
servers:
  - url: https://app.surfacd.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Project management endpoints. Reads only in this version.
  - name: Prompts
    description: Prompt management endpoints. Reads only in this version.
  - 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).
  - name: Reference
    description: Reference data used by create, update, and reporting filters.
  - name: Tags
    description: Project tag management endpoints.
paths:
  /api/v1/projects:
    get:
      tags:
        - Projects
      summary: List Projects
      description: >-
        Returns paginated projects for the current team. Excludes archived
        projects by default; pass `include_archived=1` to include them.
      operationId: v1ProjectsIndex
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: include_archived
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Include archived projects in the response.
      responses:
        '200':
          description: Paginated projects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedProject'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    PaginatedProject:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Project'
        links:
          $ref: '#/components/schemas/PaginationLinks'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - data
        - meta
    Project:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        check_frequency:
          $ref: '#/components/schemas/CheckFrequency'
        project_type:
          $ref: '#/components/schemas/ProjectType'
        pitch_ends_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            End of the 7-day pitch collection window. Only set for pitch
            projects once their first collection run starts; always null for
            standard projects. Read-only.
        prompt_limit:
          type: integer
          description: >-
            Resolved prompt limit. Falls back to the team default when not
            explicitly set on the project.
        archived_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        default_country:
          oneOf:
            - $ref: '#/components/schemas/ProjectCountry'
            - type: 'null'
        primary_brand:
          oneOf:
            - $ref: '#/components/schemas/ProjectBrand'
            - type: 'null'
        services:
          type: array
          items:
            $ref: '#/components/schemas/ProjectService'
          description: Active services (AI platforms) enabled for this project.
        share:
          $ref: '#/components/schemas/ProjectShare'
      required:
        - uuid
        - name
        - check_frequency
        - project_type
        - pitch_ends_at
        - prompt_limit
        - archived_at
        - created_at
        - updated_at
        - default_country
        - primary_brand
        - services
        - share
    PaginationLinks:
      type: object
      properties:
        first:
          type:
            - string
            - 'null'
        last:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
        next:
          type:
            - string
            - 'null'
      required:
        - first
        - last
        - prev
        - next
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/PaginationMetaLink'
        path:
          type:
            - string
            - 'null'
        per_page:
          type: integer
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
      required:
        - current_page
        - last_page
        - per_page
        - total
    ValidationError:
      type: object
      description: Returned when one or more request parameters fail validation.
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - message
        - errors
    CheckFrequency:
      type: string
      enum:
        - manual
        - monthly
        - weekly
        - daily
    ProjectType:
      type: string
      enum:
        - standard
        - pitch
      description: >-
        Project type. `pitch` projects run a fixed 7-day collection window and
        do not consume credits.
    ProjectCountry:
      type: object
      properties:
        code:
          type: string
          description: ISO 3166-1 alpha-2 country code (lowercase).
        name:
          type: string
      required:
        - code
        - name
    ProjectBrand:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        domain:
          type:
            - string
            - 'null'
        type:
          $ref: '#/components/schemas/BrandType'
        brand_aliases:
          type: array
          items:
            type: string
      required:
        - uuid
        - name
        - domain
        - type
        - brand_aliases
    ProjectService:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          description: Public platform UUID. May be sent in project `services` arrays.
        name:
          type: string
          description: Machine name (e.g. `chatgpt`).
        display_name:
          type: string
        provider:
          type: string
          description: >-
            Public provider slug. Use this in reporting `services` filters; it
            may also be sent in project `services` arrays.
      required:
        - uuid
        - name
        - display_name
        - provider
    ProjectShare:
      type: object
      properties:
        enabled:
          type: boolean
        share_url:
          type:
            - string
            - 'null'
          description: >-
            The public share URL (includes the token). Null when sharing is
            disabled.
        password_protected:
          type: boolean
          description: Whether a password is required to view the shared project.
      required:
        - enabled
        - share_url
        - password_protected
    PaginationMetaLink:
      type: object
      properties:
        url:
          type:
            - string
            - 'null'
        label:
          type: string
        active:
          type: boolean
      required:
        - url
        - label
        - active
    BrandType:
      type: integer
      enum:
        - 0
        - 1
        - 2
      description: >-
        `0` = Standard, `1` = Primary (the project's own brand), `2` =
        Competitor.
  responses:
    ValidationError:
      description: Validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        Team API key created in Team Settings. Use it with URLs for the same
        team.

````