---
title: "List payment link sharing events"
method: GET
path: "/payment-links/{paymentLinkId}/sharing-events"
tags: ["sharingEvents"]
---

# List payment link sharing events

`GET /payment-links/{paymentLinkId}/sharing-events`

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of sharing events for a payment link. A sharing event occurs when a merchant shares a payment link with a customer.  

To list the sharing events for a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the [Create Payment Link](https://docs.payroc.com/api/schema/payment-links/create) method.  

**Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payment-links/list) method to search for the payment link.  

Use query parameters to filter the list of results that we return, for example, to search for links sent to a specific customer.  

Our gateway returns the following information for each sharing event in the list:  
- Customer that the merchant sent the link to.  
- Date that the merchant sent the link.

## Path parameters

- `paymentLinkId` string, required

## Query parameters

- `recipientName` string
- `recipientEmail` string
- `before` string
- `after` string
- `limit` integer

## Headers

- `Authorization` string, required

## Response `200`

Successful request. Returns a [paginated](https://docs.payroc.com/api/pagination) list of sharing events for the payment link.

- SharingEventPaginatedList
  - `limit` integer, required — Maximum number of results that we return for each page.
  - `count` integer, required — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query.
  - `hasMore` boolean, required — Indicates whether there is another page of results available.
  - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results.
    - `rel` string, required — Indicates the relationship between the current resource and the target resource.
    - `method` string, required — HTTP method that you need to use with the target resource.
    - `href` string, required — URL of the target resource.
  - `data` SharingEventPaginatedListDataItems[], required — Array of polymorphic objects that contain information about how the merchant shared a payment link.
    - `sharingMethod` 'email', required — Method that the merchant uses to share the payment link.
    - `sharingEventId` string — Unique identifier that we assigned to the sharing event.
    - `dateTime` string, date-time — Date and time that the merchant shared the link. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
    - `merchantCopy` boolean — Indicates if we send a copy of the email to the merchant. By default, we don't send a copy to the merchant.
    - `message` string — Message that the merchant sends with the payment link.
    - `recipients` PaymentLinkEmailRecipient[], required — Array that contains the recipients of the payment link.
      - `name` string, required — Recipient's name.
      - `email` string, required — Recipient's email address.

## Other responses

- `400` — Invalid request
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `404` — Resource not found
- `406` — Not acceptable
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)