Other
What this organisation has shared, and whether each link is still live
GET
https://backend.immut.io/api/v1/share-linksRequired scope: documents:read
Revoked and expired links are included by default, because "who had access last month" is a real question.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
resourceType | query | no | document | folder | workspace |
resourceId | query | no | only links for this resource |
activeOnly | query | no | true hides revoked and expired links |
page | query | no | default 1 |
limit | query | no | default 20, max 100 |
Responses
| Status | Meaning |
|---|---|
200 | Success Returns: per row: id, resourceType, resourceId, accessLevel, expiresAt, isActive, expired, accessCount (every open), openEventsRecorded and accessLogTruncated (the access log keeps only the newest 200), createdAt. For links you created you also get recipientEmails and openedBy (the emails that actually opened it); for links someone else in the organisation created you get recipientCount and openedByCount instead, because a read key must not enumerate every outside party the organisation has ever dealt with. |
400 | BadRequest |
401 | Unauthorized |
403 | Forbidden |
429 | RateLimited |
Example
curl -X GET "https://backend.immut.io/api/v1/share-links" \
-H "Authorization: Bearer $IMMUT_API_KEY"
Generated from the immut API contract, version 1.14.0. Machine-readable: this page as markdown · everything in one file · OpenAPI