List payment link 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/payments/payment-links/create) method.
**Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payments/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
Unique identifier that we assigned to the payment link.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
recipientName
Filter results by the customer's name.
recipientEmail
Filter results by the customer's email address.
before
Return the previous page of results before the value that you specify.
You can’t send the before parameter in the same request as the after parameter.
after
Return the next page of results after the value that you specify.
You can’t send the after parameter in the same request as the before parameter.
limit
Limit the maximum number of results that we return for each page.
Response
Successful request. Returns a paginated list of sharing events for the payment link.
limit
Maximum number of results that we return for each page.
count
Number of results we returned on this page.
Note: This might not be the total number of results that match your query.
hasMore
Indicates whether there is another page of results available.
data
Array of sharing events for the payment link.
links
Reference links to navigate to the previous page of results or to the next page of results.
