How to capture the link provided in a Smartsheet share invitation mail

I regularly share a sheet. I send the invitation email. This email contains the link to the sheet. How can I get this link so I can store it?

Solution

If you just want the link to the sheet, you can get it by issuing a Get Sheet request, which returns a Sheet object. Within the Sheet object, the permalink property specifies the hyperlink that can be used to access the sheet.

Request: GET /sheets/{sheetId}

Response:

{
  "id": 4583173393803140,
  "name": "sheet 1",
  "version": 6,
  "totalRowCount": 240,
  ...
  "permalink": "https://app.smartsheet.com/b/home?lx=pWNSDH9itjBXxBzFmyf-5w",
  ...
}

Please note, the URL specified by permalink property within a Get Sheet response will link to the sheet -- but it may not be the exact same URL that that's included in the email that the recipient receives in a sharing invitation email. I haven't tested this scenario, but it should be easy for you to compare the two URLs, should you choose to do so.

UPDATE

Per the information in the comments below, the value of the permalink property in a Get Sheet response is indeed different than the URL that's included in a sharing invitation email. The link in a sharing invitation email is a system-generated URL that's not available via API.