API V3 - How do I get a list of a shares recipients and their emails?

  • 1
  • Question
  • Updated 1 year ago
  • (Edited)
I am using the API to send a share email, the post returns the AliasId of the share and I store it in my database. Now I want to go back, and use the AliasId and the email of the recipient to check if the file has been downloaded. However I cannot find any way to find the email of the user via share alias id. How do I get a list of share recipients and their emails? Is their an alternate or more straight forward way to see if files were downloaded by email?
Photo of Mikel Browning

Mikel Browning

  • 1 Post
  • 0 Reply Likes
  • frustrated

Posted 1 year ago

  • 1
Photo of Luke Skrzypek

Luke Skrzypek, Software Engineer

  • 70 Posts
  • 8 Reply Likes
Have you tried the GET https://account.sf-api.com/sf/v3/Shares(id) API to get the share object?

The IsConsumed property should tell you whether the file(s) were downloaded, and the Recipients property contains the people that it was shared with.

Alternatively, you can use GET https://account.sf-api.com/sf/v3/Shares(id)/Recipients to get all the recipients of a share or GET https://account.sf-api.com/sf/v3/Shares(shareId)/Recipients(aliasId) for a specific one