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

# Retrieve a segment group with its segments and companies

> Returns a segment group, its industry in each taxonomy, its segments, and every company with one of them: most material first, then by market cap. Each company lists the group's segments it has, with its rating of each. Needs taxonomy access in your plan.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /segments/groups/{groupId}
openapi: 3.0.0
info:
  title: Noonum API v2
  version: 2.0.0
  contact:
    name: Noonum Support
    email: hello@noonum.com
  description: >
    Create and manage investment strategies, portfolios, and backtests. The API
    covers the full strategy lifecycle, including creation and editing, the
    archive and revive flow, version submission and run state, result companies,
    evidence, factsheets, exposures, and taxonomy.
servers:
  - url: https://api.noonum.ai/v2
security:
  - bearerAuth: []
tags:
  - name: UserStrategies
    description: Create, read, update, and manage your own investment strategies.
  - name: Helper
    description: >-
      Shared utilities for company lookup and search, objective tooling, and a
      health check.
  - name: Portfolios
    description: Create, read, update, and delete portfolios.
  - name: Backtest
    description: Run a standalone backtest on a portfolio of companies.
  - name: Segments
    description: >-
      Companies' business segments, grouped into segment groups and tagged to
      GICS, NAICS and ICB industries, and the companies most similar to a
      company by the segments they share. You read a company's segment data once
      you subscribe to the company. A subscription lasts 365 days and cannot be
      cancelled or moved to another company; your plan sets how many you can
      hold at once, and `GET /segments/subscriptions` lists them.
  - name: Usage
    description: Read your plan, your remaining credits, and your credit usage.
paths:
  /segments/groups/{groupId}:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: integer
        description: Segment group ID.
    get:
      tags:
        - Segments
      summary: Retrieve a segment group with its segments and companies
      description: >-
        Returns a segment group, its industry in each taxonomy, its segments,
        and every company with one of them: most material first, then by market
        cap. Each company lists the group's segments it has, with its rating of
        each. Needs taxonomy access in your plan.
      operationId: app.api.v2.segments.group
      responses:
        '200':
          description: The segment group.
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - name
                  - description
                  - industries
                  - segments
                  - companies
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  description:
                    type: string
                    nullable: true
                  industries:
                    type: object
                    description: >-
                      A segment group's industry per taxonomy; a taxonomy the
                      group is not tagged in is left out.
                    properties:
                      gics:
                        type: object
                        description: A segment group's industry in one taxonomy.
                        required:
                          - sector
                          - path
                          - industry
                          - codes
                        properties:
                          sector:
                            description: The taxonomy's top level (ICB calls it Industry).
                            type: string
                          path:
                            description: >-
                              The levels between sector and industry: the GICS
                              industry group, the ICB supersector and sector;
                              empty for NAICS.
                            type: array
                            items:
                              type: string
                          industry:
                            description: >-
                              The level the segment group is tagged at: GICS
                              industry, NAICS subsector, ICB subsector.
                            type: string
                          codes:
                            description: >-
                              The NAICS codes or the ICB subsector code; empty
                              for GICS.
                            type: array
                            items:
                              type: string
                      naics:
                        type: object
                        description: A segment group's industry in one taxonomy.
                        required:
                          - sector
                          - path
                          - industry
                          - codes
                        properties:
                          sector:
                            description: The taxonomy's top level (ICB calls it Industry).
                            type: string
                          path:
                            description: >-
                              The levels between sector and industry: the GICS
                              industry group, the ICB supersector and sector;
                              empty for NAICS.
                            type: array
                            items:
                              type: string
                          industry:
                            description: >-
                              The level the segment group is tagged at: GICS
                              industry, NAICS subsector, ICB subsector.
                            type: string
                          codes:
                            description: >-
                              The NAICS codes or the ICB subsector code; empty
                              for GICS.
                            type: array
                            items:
                              type: string
                      icb:
                        type: object
                        description: A segment group's industry in one taxonomy.
                        required:
                          - sector
                          - path
                          - industry
                          - codes
                        properties:
                          sector:
                            description: The taxonomy's top level (ICB calls it Industry).
                            type: string
                          path:
                            description: >-
                              The levels between sector and industry: the GICS
                              industry group, the ICB supersector and sector;
                              empty for NAICS.
                            type: array
                            items:
                              type: string
                          industry:
                            description: >-
                              The level the segment group is tagged at: GICS
                              industry, NAICS subsector, ICB subsector.
                            type: string
                          codes:
                            description: >-
                              The NAICS codes or the ICB subsector code; empty
                              for GICS.
                            type: array
                            items:
                              type: string
                  segments:
                    description: By name.
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - name
                        - description
                        - nCompanies
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        description:
                          type: string
                          nullable: true
                        nCompanies:
                          description: Companies with the segment.
                          type: integer
                  companies:
                    description: Most material first, then by market cap, then by name.
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - name
                        - symbol
                        - materiality
                        - segments
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                          nullable: true
                        symbol:
                          type: string
                          nullable: true
                        materiality:
                          description: >-
                            The company's most material rating of the group's
                            segments.
                          allOf:
                            - type: string
                              description: >-
                                How material a segment is to the company: `core`
                                (a main business), `significant`, or `minor`.
                              enum:
                                - core
                                - significant
                                - minor
                        segments:
                          description: >-
                            The group's segments the company has: most material
                            first, then by segment name.
                          type: array
                          items:
                            type: object
                            required:
                              - id
                              - materiality
                            properties:
                              id:
                                type: integer
                              materiality:
                                type: string
                                description: >-
                                  How material a segment is to the company:
                                  `core` (a main business), `significant`, or
                                  `minor`.
                                enum:
                                  - core
                                  - significant
                                  - minor
        '403':
          description: Your plan does not include taxonomy access.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
        '404':
          description: The segment group was not found.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
        '409':
          description: This login's email already belongs to another Noonum account.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: |
        Enter 'Bearer' followed by a space and then your JWT or API Key.
        Example: `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`
        or `Bearer YOUR_API_KEY_HERE`

````

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