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

# Get category configuration

> Return the per-organization metrics category configuration: the list of categories with their statuses and colors, optionally scoped to a pipeline.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/contact-metrics/config
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/contact-metrics/config:
    get:
      tags:
        - Contact Metrics
      summary: Get category configuration
      description: >-
        Return the per-organization metrics category configuration: the list of
        categories with their statuses and colors, optionally scoped to a
        pipeline.
      operationId: get_metrics_config
      parameters:
        - in: query
          name: pipelineId
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Metrics config returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactMetricsConfigResponse'
        '400':
          description: Invalid pipeline ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactMetricsErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactMetricsErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ContactMetricsConfigResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: object
          properties:
            categories:
              type: array
              items:
                $ref: '#/components/schemas/ContactMetricsCategoryConfig'
            allowMultipleCategories:
              type: boolean
            defaultMetricsPipelineId:
              type: string
              nullable: true
            pipelineId:
              type: string
              nullable: true
              description: Set when GET is called with ?pipelineId=.
            pipelineName:
              type: string
              nullable: true
              description: Set when GET is called with ?pipelineId=.
          additionalProperties: true
      required:
        - success
        - data
      additionalProperties: true
      example:
        success: true
        data:
          categories:
            - name: New
              key: new
              statuses:
                - new
              color: '#3B82F6'
            - name: Working
              key: working
              statuses:
                - qualified
                - in-progress
              color: '#10B981'
          allowMultipleCategories: false
          defaultMetricsPipelineId: 66f0a0b0c0d0e0f0a0b0c0d0
          pipelineId: 66f0a0b0c0d0e0f0a0b0c0d0
          pipelineName: Sales pipeline
    ContactMetricsErrorResponse:
      type: object
      description: >-
        Error envelope returned by contact-metrics endpoints. Errors are
        returned as `{ error: <message> }`.
      properties:
        error:
          type: string
      additionalProperties: true
      example:
        error: Invalid pipeline ID
    ContactMetricsCategoryConfig:
      type: object
      description: >-
        A single category entry in
        `Organization.contactMetricsConfig.categories`.
      properties:
        name:
          type: string
        key:
          type: string
        statuses:
          type: array
          items:
            type: string
        color:
          type: string
        pipelineId:
          type: string
          nullable: true
      additionalProperties: true
      example:
        name: Working
        key: working
        statuses:
          - qualified
          - in-progress
        color: '#10B981'
        pipelineId: 66f0a0b0c0d0e0f0a0b0c0d0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````