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

# List groupings

> Returns a simplified list of groupings for a carrier, filtering out consist-related grouping types for third-party consumers.



## OpenAPI

````yaml /user-docs/api-reference/external-openapi.json post /ims/groupings/list
openapi: 3.1.0
info:
  title: ARMS External API
  version: 1.0.0
  description: >-
    OpenAPI specification generated from external API schemas. Endpoints require
    query parameter carrierId and headers x-arms-api-key and x-arms-assume-user.
  license:
    name: Proprietary
    url: https://cedarai.com
servers:
  - url: https://api-lg.arms.cedarai.com
    description: Production (US)
  - url: https://api-lg.arms.cedarai.se
    description: Production (EU)
security:
  - ApiKeyAuth: []
    AssumeUser: []
paths:
  /ims/groupings/list:
    post:
      summary: List groupings
      description: >-
        Returns a simplified list of groupings for a carrier, filtering out
        consist-related grouping types for third-party consumers.
      operationId: listGroupingsThirdParty
      parameters:
        - $ref: '#/components/parameters/CarrierId'
        - $ref: '#/components/parameters/ViewAsUserGroup'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimplifiedListGroupingInput'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGroupingsOutput'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    CarrierId:
      name: carrierId
      in: query
      required: true
      schema:
        type: integer
      description: Carrier identifier; required for all endpoints
    ViewAsUserGroup:
      name: viewAsUserGroup
      in: query
      required: false
      schema:
        type: string
      description: Optional user group context
  schemas:
    SimplifiedListGroupingInput:
      type: object
      properties:
        carrierId:
          type: integer
          description: Carrier identifier used to scope groupings.
        includedGroupingTypes:
          type: array
          items:
            type: string
          description: List of grouping types to include.
        names:
          type: array
          items:
            type: string
          description: List of grouping names to include.
      required:
        - carrierId
    ListGroupingsOutput:
      type: object
      properties:
        groupings:
          type: array
          items:
            $ref: '#/components/schemas/SingleGroupingOutput'
    Error:
      type: object
      properties:
        message:
          type: string
    SingleGroupingOutput:
      allOf:
        - $ref: '#/components/schemas/Grouping'
        - type: object
          properties:
            carrierId:
              type: integer
              description: Carrier identifier associated with the grouping.
    Grouping:
      type: object
      properties:
        resourceType:
          type: string
          enum:
            - Grouping
        resourceId:
          type: integer
        uuid:
          type: string
          description: UUID that complements the legacy numeric resourceId.
        name:
          type: string
        groupingType:
          type: string
        colorToken:
          type: string
        attributes:
          $ref: '#/components/schemas/AttributesBase'
        rules:
          $ref: '#/components/schemas/GroupingRule'
        equipmentIndexEnabled:
          type: boolean
          enum:
            - false
        deletedAt:
          type: string
        updatedAt:
          type: string
        objectType:
          type: string
          enum:
            - EQUIPMENT
            - CONTAINER
      required:
        - resourceType
        - resourceId
        - groupingType
        - attributes
        - rules
        - equipmentIndexEnabled
        - objectType
    AttributesBase:
      type: object
      description: Base attribute payload for grouping resources.
      additionalProperties: true
    GroupingRule:
      type: object
      description: Optional grouping rule configuration.
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-arms-api-key
      description: Your ARMS API key
    AssumeUser:
      type: apiKey
      in: header
      name: x-arms-assume-user
      description: Email of a user assigned to the appropriate user group

````