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

# Get Team Settings

> Returns settings for the current team, plus its plan name, display prices, and the features included on that plan. The plan is read-only and cannot be changed through the API.



## OpenAPI

````yaml /openapi.json get /api/v1/team
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/team:
    get:
      tags:
        - Team
      summary: Get Team Settings
      description: >-
        Returns settings for the current team, plus its plan name, display
        prices, and the features included on that plan. The plan is read-only
        and cannot be changed through the API.
      operationId: v1TeamShow
      responses:
        '200':
          description: Team settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamSettings'
components:
  schemas:
    TeamSettings:
      type: object
      properties:
        name:
          type: string
        default_country:
          oneOf:
            - $ref: '#/components/schemas/ProjectCountry'
            - type: 'null'
        primary_color:
          type: string
          description: Brand colour as a hex string (e.g. `#0022ff`).
        default_prompt_limit:
          type: integer
        max_schedule_frequency:
          $ref: '#/components/schemas/CheckFrequency'
        user_auto_provisioning_enabled:
          type: boolean
          description: Whether the team has any auto-provision email domains configured.
        billing:
          $ref: '#/components/schemas/TeamBilling'
      required:
        - name
        - default_country
        - primary_color
        - default_prompt_limit
        - max_schedule_frequency
        - user_auto_provisioning_enabled
        - billing
    ProjectCountry:
      type: object
      properties:
        code:
          type: string
          description: ISO 3166-1 alpha-2 country code (lowercase).
        name:
          type: string
      required:
        - code
        - name
    CheckFrequency:
      type: string
      enum:
        - manual
        - monthly
        - weekly
        - daily
    TeamBilling:
      type: object
      properties:
        plan:
          type: string
          description: Human-readable plan name (e.g. `Pro`).
        prices:
          type:
            - object
            - 'null'
          description: >-
            Display prices keyed by interval then lowercase currency code, in
            the smallest currency unit (e.g. cents). Null for plans without
            self-serve pricing (Trial/Custom).
          additionalProperties:
            type: object
            additionalProperties:
              type: integer
        features:
          $ref: '#/components/schemas/PlanFeatures'
      required:
        - plan
        - prices
        - features
    PlanFeatures:
      type: object
      description: What the team's plan includes.
      properties:
        max_projects:
          type:
            - integer
            - 'null'
          description: Maximum active projects, or null for unlimited.
        max_services_per_project:
          type:
            - integer
            - 'null'
          description: Maximum services per project, or null for unlimited.
        available_frequencies:
          type: array
          items:
            $ref: '#/components/schemas/CheckFrequency'
          description: Schedule frequencies the plan permits.
        api_access:
          type: boolean
        prompt_limit_adjustable:
          type: boolean
        auto_provisioning:
          type: boolean
        branding:
          type: boolean
      required:
        - max_projects
        - max_services_per_project
        - available_frequencies
        - api_access
        - prompt_limit_adjustable
        - auto_provisioning
        - branding
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        Team API key created in Team Settings. Use it with URLs for the same
        team.

````