Skip to main content

shareLinks

Returns the share links created for a specific resource.

Business Rules​

  • Only resource types registered as shareable are supported.
  • Links are returned newest first, including revoked and expired ones so they can be managed.

Error Scenarios​

  • **UNAUTHORIZED**: when the requester lacks permission on the company that owns the resource, or the resource does not exist.

Permissions Required​

  • sharing:read_links permission
shareLinks(
  resourceId: ID!
  resourceType: String!
): [ShareLink!]!

Arguments​

shareLinks.resourceId ● ID! non-null scalar common​

ID of the resource

shareLinks.resourceType ● String! non-null scalar common​

Type of resource (e.g. "OrderFulfillment")

Type​

ShareLink object common​

Represents a share link for sharing resources with external users.