---
title: "Get platforms from EAM"
url: "https://apiportal-ppd.np.six-group.com/apis/eam-public-v1-api-az-ch-preprod-v1/versions/46a433cc-2c51-4d40-83e4-c9868fcbc0b0/operations/getPlatforms"
---

> Full API specification: https://apiportal-ppd.np.six-group.com/apis/eam-public-v1-api-az-ch-preprod-v1/versions/46a433cc-2c51-4d40-83e4-c9868fcbc0b0.md

# Get platforms from EAM

`GET` `/platforms`

Operation ID: `getPlatforms`

Returns the list of platforms from the EAM system.

## Query parameters

- `start` (integer, int32, optional) - Zero-based offset of the first item to return. Defaults to 0 when omitted.
- `count` (integer, int32, optional) - Maximum number of items to return. Defaults to 50 when omitted.
- `includeAll` (boolean, optional) - When set to true, returns platforms including "Final" state. Defaults to false when omitted.

## Responses

- `200` - Platforms list.
- `401` - Missing or invalid credentials.
- `403` - The caller does not have permission to access this resource.
- `500` - An unexpected server-side error occurred.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: EAM API
  version: 0.0.1
servers:
  - url: https://api-preprod.np.azure.six-group.com:8443/eal/ext/v1
paths:
  /platforms:
    get:
      tags:
        - Platforms
      summary: Get platforms from EAM
      description: Returns the list of platforms from the EAM system.
      operationId: getPlatforms
      parameters:
        - name: start
          in: query
          description: Zero-based offset of the first item to return. Defaults to 0 when
            omitted.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
            default: 0
            minimum: 0
        - name: count
          in: query
          description: Maximum number of items to return. Defaults to 50 when omitted.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
            default: 50
            maximum: 200
            minimum: 1
        - name: includeAll
          in: query
          description: When set to true, returns platforms including "Final" state.
            Defaults to false when omitted.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: false
      responses:
        "200":
          description: Platforms list.
          headers:
            traceparent:
              $ref: "#/components/headers/traceparent"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PlatformListResponse"
        "401":
          $ref: "#/components/responses/Unauthenticated"
        "403":
          $ref: "#/components/responses/Forbidden"
        "500":
          $ref: "#/components/responses/InternalServerError"
      security:
        - bearerAuth: []
security:
  - bearerAuth: []
components:
  headers:
    traceparent:
      description: W3C Trace Context traceparent header. Include in all downstream
        calls and log entries.
      style: simple
      explode: false
      schema:
        type: string
  schemas:
    PlatformListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/PlatformItem"
        pagination:
          $ref: "#/components/schemas/PaginationMeta"
      required:
        - data
        - pagination
    PlatformItem:
      type: object
      properties:
        businessKey:
          type: string
        name:
          type: string
        longName:
          type: string
        description:
          type: string
        lifecyclePhase:
          type: string
        stakeholders:
          $ref: "#/components/schemas/EamStakeholder"
        platformDomain:
          type: array
          items:
            $ref: "#/components/schemas/EamBusinessKeyRef"
    PaginationMeta:
      type: object
      properties:
        page:
          type: integer
          description: Current page index (0-indexed).
        pageSize:
          type: integer
        totalCount:
          type: integer
        totalPages:
          type: integer
      required:
        - page
        - pageSize
        - totalCount
        - totalPages
    ErrorResponse:
      type: object
      description: Canonical error payload as defined in the SIX Group REST API Guidelines.
      properties:
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp of when the error was produced.
        status:
          type: integer
          description: HTTP status code (RFC 7231 6).
        code:
          type: string
          description: Machine-readable application-specific error code (e.g.
            RESOURCE_NOT_FOUND).
        message:
          type: string
          description: Human-readable summary of the problem.
        path:
          type:
            - string
            - "null"
          description: Request path that produced the error. Optional.
        traceId:
          type:
            - string
            - "null"
          description: W3C trace ID (32-char lowercase hex) for correlation.
        invalidParams:
          type: array
          description: Parameters whose values failed validation. Omitted when empty.
          items:
            $ref: "#/components/schemas/InvalidParam"
      required:
        - message
        - status
        - timestamp
    EamStakeholder:
      type: object
      properties:
        governanceRole:
          $ref: "#/components/schemas/EamGovernanceRole"
        supportGroup:
          $ref: "#/components/schemas/EamSupportGroup"
        supportMailbox:
          $ref: "#/components/schemas/EamSupportMailbox"
        subjectMatterExpert:
          type: array
          items:
            $ref: "#/components/schemas/EamUser"
    EamBusinessKeyRef:
      type: object
      properties:
        businessKey:
          type: string
        name:
          type: string
    InvalidParam:
      type: object
      properties:
        in:
          type: string
          description: Location of the invalid parameter.
          enum:
            - BODY
            - PATH
            - QUERY
            - HEADER
        name:
          type: string
          description: Name of the invalid parameter.
        reason:
          type: string
          description: Why the parameter value is invalid.
        value:
          type:
            - string
            - "null"
          description: The rejected value. May be null when unsafe to echo back.
      required:
        - in
        - name
        - reason
    EamGovernanceRole:
      type: object
      additionalProperties:
        type: array
        items:
          $ref: "#/components/schemas/EamUser"
      description: Governance roles keyed by the EAM role name e.g.
        appITManagerPrimary, appITManagerDeputy, appITArchitectPrimary,
        appITArchitectDeputy, appITOwnerPrimary, appITOwnerDeputy,
        appITOperatorPrimary, appITOperatorDeputy, appBusOwnerPrimary,
        appBusOwnerDeputy, appBusManagerPrimary, appBusManagerDeputy,
        appITDomainOwnerPrimary, appITDomainOwnerDeputy,
        appITDomainArchitectPrimary, appITDomainArchitectDeputy,
        businessServiceOwnerPrimary, businessServiceOwnerDeputy,
        platformManagerPrimary, platformManagerDeputy, platformArchitectPrimary,
        platformArchitectDeputy, platformOwnerPrimary, platformOwnerDeputy,
        platformOperatorPrimary, platformOperatorDeputy,
        platformDomainOwnerPrimary, platformDomainOwnerDeputy,
        platformDomainArchitectPrimary, platformDomainArchitectDeputy,
        softwareManagerPrimary, softwareManagerDeputy.
    EamSupportGroup:
      type: array
      items:
        type: object
        properties:
          roleName:
            type: string
          name:
            type: string
          businessKey:
            type: string
    EamSupportMailbox:
      type: array
      items:
        type: object
        properties:
          roleName:
            type: string
          name:
            type: string
    EamUser:
      type: object
      properties:
        roleName:
          type: string
        name:
          type: string
        emailAddress:
          type: string
        userId:
          type: string
  responses:
    Unauthenticated:
      description: Missing or invalid credentials.
      headers:
        traceparent:
          $ref: "#/components/headers/traceparent"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    Forbidden:
      description: The caller does not have permission to access this resource.
      headers:
        traceparent:
          $ref: "#/components/headers/traceparent"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    InternalServerError:
      description: An unexpected server-side error occurred.
      headers:
        traceparent:
          $ref: "#/components/headers/traceparent"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
```