---
title: "List stakeholders"
method: GET
path: "/stakeholder-comms/cloudId/{cloudId}/api/stakeholders/list"
tags: ["Stakeholder User management"]
---

# List stakeholders

`GET /stakeholder-comms/cloudId/{cloudId}/api/stakeholders/list`

Get a list of stakeholders.

## Query parameters

- `status` string
- `type` string
- `searchField` string
- `searchValue` string
- `orderBy` string
- `descending` boolean
- `first` integer
- `after` string
- `last` integer
- `before` string

## Response `200`

Returned if the request is successful.

- StakeholderCommsStakeholderConnectionResponse — Response containing a list of stakeholders.
  - `connection` StakeholderCommsStakeholderConnection — Connection-style response for listing stakeholders.
    - `nodes` StakeholderCommsStakeholder[]
      - `id` string — Unique identifier of the stakeholder.
      - `ari` string — Atlassian Resource Identifier for the stakeholder.
      - `aaid` string — Atlassian Account ID.
      - `stakeholderGroupId` string — Group the stakeholder belongs to.
      - `atlassianTeamId` string — Atlassian team ID.
      - `type` 'EXTERNAL' | 'INTERNAL' | 'GROUP' | 'TEAM' — Type of the stakeholder.
      - `skipConfirmation` boolean — Whether confirmation was skipped for this stakeholder.
      - `status` 'ACTIVE' | 'PENDING_IDENTITY_SETUP' | 'INVITED' | 'INVITED_PENDING_APPROVAL' | 'NOT_INVITED' | 'QUARANTINED' | 'DELETED' — Status of the stakeholder.
      - `notificationPreference` StakeholderCommsNotificationPreference — Notification preference details for a stakeholder.
        - `id` string — Identifier of the notification preference.
        - `emailId` string — Email address for notifications.
        - `phoneNumber` string — Phone number for SMS notifications.
        - `phoneCountry` string — Country code for the phone number.
        - `webhook` string — Webhook URL for notifications.
        - `preference` StakeholderCommsNotificationChannels — Per-channel notification enablement settings.
          - `email` object
            - `enabled` boolean
          - `sms` object
            - `enabled` boolean
          - `webhook` object
            - `enabled` boolean
        - `insertedAt` string, date-time — When the preference was created.
        - `updatedAt` string, date-time — When the preference was last updated.
      - `insertedAt` string, date-time — When the stakeholder was created.
      - `updatedAt` string, date-time — When the stakeholder was last updated.
      - `name` string — Display name of the stakeholder (from identity provider).
      - `avatar` string — Avatar URL for the stakeholder.
      - `groups` StakeholderCommsStakeholderGroupRef[] — Groups the stakeholder belongs to.
        - `id` string — Identifier of the group.
        - `name` string — Name of the group.
        - `avatar` string — Avatar URL for the group.
    - `pageInfo` object — Pagination information.
      - `hasNextPage` boolean — Whether there is another page of results.
      - `endCursor` string — Cursor for the end of the current page.
    - `totalCount` integer — Total number of stakeholders matching the filter.
  - `error` string — Error message, if the operation was not successful.

## Other responses

- `400` — Returned if the request is invalid.
- `401` — Returned if the authentication credentials are incorrect.
- `403` — Returned if the user does not have permission to list stakeholders.
- `500` — Returned if an internal server error occurs.

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)