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

# List project sessions

> Lists every session in the authenticated organization or selected project, including disconnected sessions and their latest status reason.

Requires `sessions:read`. Project tokens only access resources in their own project.



## OpenAPI

````yaml api-reference/features/connect.json GET /platform/sessions
openapi: 3.0.3
info:
  title: Connect API methods
  version: 1.0.0
  description: Task-focused connect methods across supported Polymorfa connection types.
servers: []
security: []
paths:
  /platform/sessions:
    get:
      tags:
        - Sessions
      summary: List project sessions
      description: >-
        Lists every session in the authenticated organization or selected
        project, including disconnected sessions and their latest status reason.


        Requires `sessions:read`. Project tokens only access resources in their
        own project.
      operationId: managementListPlatformSessions
      parameters:
        - name: projectId
          in: query
          required: false
          schema:
            type: string
          description: Identifier of the Polymorfa project that owns this resource.
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Stable request correlation identifier.
            Polymorfa-Version:
              schema:
                type: string
              description: API version applied to this response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/management__PlatformSession'
                    description: Structured data carried by this object.
                required:
                  - data
        '400':
          $ref: '#/components/responses/management__BadRequest'
        '401':
          $ref: '#/components/responses/management__Unauthorized'
        '403':
          $ref: '#/components/responses/management__Forbidden'
      security:
        - management__ApiKeyAuth: []
      servers:
        - url: https://api.polymorfa.com
        - url: http://localhost:8080
          description: local dev
components:
  schemas:
    management__PlatformSession:
      type: object
      additionalProperties: false
      properties:
        _id:
          type: string
          format: uuid
          description: |-
            Identifier for the resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        _creationTime:
          type: number
          description: Creation time as Unix epoch milliseconds.
        projectId:
          allOf:
            - $ref: '#/components/schemas/management__ProjectId'
          description: |-
            Identifier of the Polymorfa project that owns this resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        sessionId:
          allOf:
            - $ref: '#/components/schemas/management__SessionIdentifier'
          description: |-
            Identifier of the connected Polymorfa session.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | String length | `1` through `64` characters |
        name:
          type: string
          nullable: true
          description: |-
            Session identifier used to address this linked-device session.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        phone:
          type: string
          nullable: true
          description: |-
            Phone number in international format.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        platform:
          type: string
          nullable: true
          description: |-
            Specifies platform for this management platform session.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        isBusiness:
          type: boolean
          description: Whether business.
        testMode:
          type: boolean
          description: Behavior selected for test.
        tierOverride:
          type: string
          enum:
            - free
            - standard
            - pro
            - scale
            - null
          nullable: true
          description: >-
            Specifies tier override for this management platform session.


            <!-- polymorfa-input-table -->

            **Allowed values**

            | Value | Meaning |

            | --- | --- |

            | `free` | Free. |

            | `standard` | Standard. |

            | `pro` | Pro. |

            | `scale` | Scale. |

            | `null` | Null. |


            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `string`; Value `free` or `standard` or
            `pro` or `scale` |

            | Alternative 2 | `null` |
        status:
          type: string
          description: Latest runtime connection status.
        statusReason:
          type: string
          nullable: true
          description: >-
            Machine-readable reason for the latest connection status, when
            available.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `string` |

            | Alternative 2 | `null` |
        messageCount:
          type: integer
          minimum: 0
          description: |-
            Number of messages.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        lastActiveAt:
          type: number
          nullable: true
          description: |-
            Last activity time as Unix epoch milliseconds.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `number` |
            | Alternative 2 | `null` |
        customer:
          type: object
          nullable: true
          additionalProperties: false
          properties:
            id:
              type: string
              format: uuid
              description: |-
                Identifier for this resource.

                <!-- polymorfa-input-table -->
                **Value constraints**
                | Constraint | Accepted input |
                | --- | --- |
                | Format | `uuid` |
            name:
              type: string
              nullable: true
              description: |-
                Human-readable name for this resource.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
            isDefault:
              type: boolean
              description: Whether default.
          required:
            - id
            - name
            - isDefault
          description: >-
            Structured customer values for this management platform session.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `object`; Required fields: `id`, `name`,
            `isDefault` |

            | Alternative 2 | `null` |
        claim:
          oneOf:
            - type: object
              additionalProperties: false
              properties:
                kind:
                  type: string
                  enum:
                    - unclaimed
                  description: |-
                    Kind discriminator for this object.

                    <!-- polymorfa-input-table -->
                    **Allowed values**
                    | Value | Meaning |
                    | --- | --- |
                    | `unclaimed` | Unclaimed. |
              required:
                - kind
            - type: object
              additionalProperties: false
              properties:
                kind:
                  type: string
                  enum:
                    - claimed-elsewhere
                  description: |-
                    Kind discriminator for this object.

                    <!-- polymorfa-input-table -->
                    **Allowed values**
                    | Value | Meaning |
                    | --- | --- |
                    | `claimed-elsewhere` | Claimed elsewhere. |
                displayName:
                  type: string
                  description: Human-readable display name.
                avatarUrl:
                  type: string
                  nullable: true
                  description: |-
                    URL for the avatar.

                    <!-- polymorfa-input-table -->
                    **Accepted alternatives**
                    | Alternative | Accepted input |
                    | --- | --- |
                    | Alternative 1 | Type: `string` |
                    | Alternative 2 | `null` |
                avatarSeed:
                  type: string
                  description: Specifies avatar seed for this one of.
                claimedAt:
                  type: number
                  description: Timestamp for claimed at.
              required:
                - kind
                - displayName
                - avatarUrl
                - avatarSeed
                - claimedAt
          description: >-
            Specifies claim for this management platform session.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `object`; Field `kind`: `unclaimed`;
            Required fields: `kind` |

            | Alternative 2 | Type: `object`; Field `kind`: `claimed-elsewhere`;
            Required fields: `kind`, `displayName`, `avatarUrl`, `avatarSeed`,
            `claimedAt` |
      required:
        - _id
        - _creationTime
        - projectId
        - sessionId
        - name
        - phone
        - platform
        - isBusiness
        - testMode
        - tierOverride
        - status
        - statusReason
        - messageCount
        - lastActiveAt
        - customer
        - claim
    management__ProjectId:
      type: string
      format: uuid
      description: >-
        Project UUID. Optional where an operation can infer or search
        organization scope; required where the operation creates a project-owned
        resource.
    management__SessionIdentifier:
      type: string
      minLength: 1
      maxLength: 64
      description: Database session UUID or stable session slug.
    management__ErrorEnvelope:
      type: object
      required:
        - error
        - data
        - docs
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              description: Stable failure code. Use this value for programmatic handling.
            message:
              type: string
              description: Safe explanation of the failure.
            param:
              type: string
              nullable: true
              description: |-
                Invalid request field, or null when no field applies.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Documentation link to this failure code.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
  responses:
    management__BadRequest:
      description: A path, query, or request-body value did not pass validation.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Unauthorized:
      description: Missing/invalid credential for this audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Forbidden:
      description: Authenticated but lacks the required scope/role/audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
  securitySchemes:
    management__ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Polymorfa server credential: a scoped pmfa_ organization key, or a
        pmfa_pt_ project token on project- and session-bound operations inside
        its exact authenticated project. Keys may be personal or service-account
        owned. Both enforce selected action scopes; organization keys can
        address team resources and every project in the organization. Listener
        and browser client credentials are rejected.

````