# Stakeholders
URL: https://docs.awellhealth.com/api-reference/reference/stakeholders

> For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt).



Look up the stakeholders that participate in a care flow.

## Queries [#queries]

### `filterStakeholders` [#filterstakeholders]

Returns the stakeholders matching the given care flow definition, release, and stakeholder definition filters.

**Arguments**

| Argument                     | Type        | Required | Description                                                       |
| ---------------------------- | ----------- | -------- | ----------------------------------------------------------------- |
| `pathway_definition_ids`     | `[String!]` | No       | The IDs of the care flow definitions                              |
| `release_ids`                | `[String!]` | No       | The IDs of the published care flow definition versions (releases) |
| `stakeholder_definition_ids` | `[String!]` | No       | The IDs of the stakeholder definitions                            |

**Returns:** `StakeholdersPayload!`

**Example**

```graphql
query FilterStakeholders($pathway_definition_ids: [String!], $release_ids: [String!], $stakeholder_definition_ids: [String!]) {
  filterStakeholders(pathway_definition_ids: $pathway_definition_ids, release_ids: $release_ids, stakeholder_definition_ids: $stakeholder_definition_ids) {
    code
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}
```

Variables:

```json
{
  "pathway_definition_ids": [
    "<string>"
  ],
  "release_ids": [
    "<string>"
  ],
  "stakeholder_definition_ids": [
    "<string>"
  ]
}
```

### `stakeholdersByDefinitionIds` [#stakeholdersbydefinitionids]

Returns the stakeholders for the given stakeholder definition IDs.

**Arguments**

| Argument                     | Type         | Required | Description                            |
| ---------------------------- | ------------ | -------- | -------------------------------------- |
| `stakeholder_definition_ids` | `[String!]!` | Yes      | The IDs of the stakeholder definitions |

**Returns:** `StakeholdersPayload!`

**Example**

```graphql
query StakeholdersByDefinitionIds($stakeholder_definition_ids: [String!]!) {
  stakeholdersByDefinitionIds(stakeholder_definition_ids: $stakeholder_definition_ids) {
    code
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}
```

Variables:

```json
{
  "stakeholder_definition_ids": [
    "<string>"
  ]
}
```

### `stakeholdersByPathwayDefinitionIds` [#stakeholdersbypathwaydefinitionids]

Returns the stakeholders for the given care flow definition IDs.

**Arguments**

| Argument                 | Type         | Required | Description                          |
| ------------------------ | ------------ | -------- | ------------------------------------ |
| `pathway_definition_ids` | `[String!]!` | Yes      | The IDs of the care flow definitions |

**Returns:** `StakeholdersPayload!`

**Example**

```graphql
query StakeholdersByPathwayDefinitionIds($pathway_definition_ids: [String!]!) {
  stakeholdersByPathwayDefinitionIds(pathway_definition_ids: $pathway_definition_ids) {
    code
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}
```

Variables:

```json
{
  "pathway_definition_ids": [
    "<string>"
  ]
}
```

### `stakeholdersByReleaseIds` [#stakeholdersbyreleaseids]

Returns the stakeholders for the given published care flow definition versions (releases).

**Arguments**

| Argument      | Type         | Required | Description                                                       |
| ------------- | ------------ | -------- | ----------------------------------------------------------------- |
| `release_ids` | `[String!]!` | Yes      | The IDs of the published care flow definition versions (releases) |

**Returns:** `StakeholdersPayload!`

**Example**

```graphql
query StakeholdersByReleaseIds($release_ids: [String!]!) {
  stakeholdersByReleaseIds(release_ids: $release_ids) {
    code
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}
```

Variables:

```json
{
  "release_ids": [
    "<string>"
  ]
}
```