# IRPCSharedLinks.GetSharedLinkRecipients

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md) > [Vault API](https://developer.m-files.com/APIs/gRPC-API/vault/index.md) > [Shared links](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/GetSharedLinkRecipients/

Badges: `Vault API / standard` `write` `session or assertion` `returns metadata structure version`

Lists the visitors (email recipients) of an external or visitor link.

- **Service:** [Shared links](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/index.md) `MFiles.IRPCSharedLinks`
- **gRPC method:** `/MFiles.IRPCSharedLinks/GetSharedLinkRecipients`
- **HTTP (mf-http-grpc):** `POST /grpc/v1/get-shared-link-recipients`
- **Request:** [`GetSharedLinkRecipientsRequest`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/GetSharedLinkRecipients/index.md#request)
- **Response:** [`GetSharedLinkRecipientsResponse`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/GetSharedLinkRecipients/index.md#response)
- **Book and level:** Vault API, standard
- **Kind:** write
- **Session:** Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
- **Idempotent:** no
- **Returns metadata structure version:** yes (in the mfiles-metadata-version-bin trailer)
- **Streaming:** none (unary)

<a id="remarks"></a>

## Remarks

- Users who cannot see the full list of visitors (see `visitor_list_restricted` in
  [GetExternalSharingSettings](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/GetExternalSharingSettings/index.md)) get
  only the recipients they added themselves.
- Recipients with a name are returned in mailbox form (`Name <address>`).
- Reading the visitors of an external link is recorded in the vault's event log.

<a id="request"></a>

## Request: GetSharedLinkRecipientsRequest

> Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

| Field | Type | Description |
|---|---|---|
| `access_key` | `string` | The access key of the link. |

<a id="response"></a>

## Response: GetSharedLinkRecipientsResponse

> Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

| Field | Type | Description |
|---|---|---|
| `recipients[]` | repeated [`SharedLinkRecipient`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.SharedLinkRecipient/index.md) | The recipients, with their expiration time and access type. |
| `recipients[].email` | `string` | The recipient email. |
| `recipients[].access_time` | [`google.protobuf.Timestamp`](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | The access time for the shared link. Is set by the server. |
| `recipients[].created_by_user` | `int32` | The creator of this shared Link. |
| `recipients[].shared_link_notification` | [`SharedLinkNotification`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.SharedLinkNotification/index.md) | Shared link notification type. Values: `SHARED_LINK_NOTIFICATION_NONE` (0), `SHARED_LINK_NOTIFICATION_ALWAYS` (1). |
| `recipients[].expires_at_utc` | [`google.protobuf.Timestamp`](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | The expiration time for the shared link. Use FILETIME_ZERO to indicate no expiration time. |
| `recipients[].external_shared_link_access_type` | [`ExternalSharedLinkAccessType`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.ExternalSharedLinkAccessType/index.md) | The access type of the recipient. Values: `EXTERNAL_SHARED_LINK_ACCESS_TYPE_UNINITIALIZED` (0), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_DOWNLOAD` (1), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_PREVIEW` (2), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_EDIT` (3). |
| `recipients[].created_by_user_name` | `string` | The user who created the shared link. |

<a id="related"></a>

## Related methods

- [GetExternalSharingSettings](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/GetExternalSharingSettings/index.md): Tells whether sharing is enabled in the vault and what the caller may do with external links.
- [GetSharedLink](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/GetSharedLink/index.md): Gets one shared link by its access key.