> ## 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 company's segments and their peers

> Returns a company's business segments, each with its segment group and its peers: the other companies with the same segment, counted, with the top 8 named (most material first, then by market cap); `/segments/groups/{groupId}` lists them all. Items found for the company that are not a market for products or services come separately. Take the company ID from `/helper/companies/search`; a company with no segment data returns empty lists. You must be subscribed to the company.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /segments/companies/{companyId}
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/companies/{companyId}:
    parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: Company (issuer) ID in the Noonum database.
    get:
      tags:
        - Segments
      summary: Retrieve a company's segments and their peers
      description: >-
        Returns a company's business segments, each with its segment group and
        its peers: the other companies with the same segment, counted, with the
        top 8 named (most material first, then by market cap);
        `/segments/groups/{groupId}` lists them all. Items found for the company
        that are not a market for products or services come separately. Take the
        company ID from `/helper/companies/search`; a company with no segment
        data returns empty lists. You must be subscribed to the company.
      operationId: app.api.v2.segments.company
      responses:
        '200':
          description: The company's segments.
          content:
            application/json:
              schema:
                type: object
                required:
                  - company
                  - segments
                  - nonMarketItems
                properties:
                  company:
                    type: object
                    required:
                      - id
                      - name
                      - symbol
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                        nullable: true
                      symbol:
                        type: string
                        nullable: true
                  segments:
                    description: Most material first, then by name.
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - name
                        - description
                        - materiality
                        - segmentGroup
                        - peers
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        description:
                          type: string
                          nullable: true
                        materiality:
                          description: The company's rating of the segment.
                          allOf:
                            - type: string
                              description: >-
                                How material a segment is to the company: `core`
                                (a main business), `significant`, or `minor`.
                              enum:
                                - core
                                - significant
                                - minor
                        segmentGroup:
                          description: >-
                            The segment group the segment belongs to; null when
                            it belongs to none.
                          type: object
                          nullable: true
                          required:
                            - id
                            - name
                            - description
                            - industries
                          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
                        peers:
                          description: >-
                            The other companies with the segment: how many, and
                            the first 8.
                          type: object
                          required:
                            - count
                            - top
                          properties:
                            count:
                              type: integer
                            top:
                              description: >-
                                Most material first, then by market cap, then by
                                name.
                              type: array
                              items:
                                type: object
                                required:
                                  - id
                                  - name
                                  - symbol
                                  - materiality
                                properties:
                                  id:
                                    type: string
                                    format: uuid
                                  name:
                                    type: string
                                    nullable: true
                                  symbol:
                                    type: string
                                    nullable: true
                                  materiality:
                                    type: string
                                    description: >-
                                      How material a segment is to the company:
                                      `core` (a main business), `significant`,
                                      or `minor`.
                                    enum:
                                      - core
                                      - significant
                                      - minor
                  nonMarketItems:
                    description: >-
                      Items found for the company that are not a market for
                      products or services, with the company's rating of each;
                      most material first.
                    type: array
                    items:
                      type: object
                      required:
                        - name
                        - materiality
                      properties:
                        name:
                          type: string
                        materiality:
                          type: string
                          description: >-
                            How material a segment is to the company: `core` (a
                            main business), `significant`, or `minor`.
                          enum:
                            - core
                            - significant
                            - minor
        '400':
          description: The `companyId` is not a valid UUID.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
        '403':
          description: >-
            Your plan does not include segment data, or you are not subscribed
            to the company.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Returned when your plan does not include segment data, or when
                  you are not subscribed to a company of the request.
                required:
                  - error
                properties:
                  error:
                    type: string
                  companyIds:
                    description: The companies of the request you are not subscribed to.
                    type: array
                    items:
                      type: string
                      format: uuid
        '404':
          description: The company 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.