Skip to main content

ShareLink

Represents a share link for sharing resources with external users.

type ShareLink {
  createdAt: ISO8601DateTime!
  expiresAt: ISO8601DateTime
  hasPassword: Boolean!
  id: ID!
  isActive: Boolean!
  lastAccessedAt: ISO8601DateTime
  maxViews: Int
  resourceId: ID!
  resourceType: String!
  token: String!
  updatedAt: ISO8601DateTime!
  url: String!
  viewCount: Int!
}

Fields​

ShareLink.createdAt ● ISO8601DateTime! non-null scalar common​

When the link was created.

ShareLink.expiresAt ● ISO8601DateTime scalar common​

When the link stops resolving. Null means it never expires.

ShareLink.hasPassword ● Boolean! non-null scalar common​

Whether the link requires a password.

ShareLink.id ● ID! non-null scalar common​

Unique identifier of the share link.

ShareLink.isActive ● Boolean! non-null scalar common​

Whether the link is active (not revoked).

ShareLink.lastAccessedAt ● ISO8601DateTime scalar common​

When the link was last viewed.

ShareLink.maxViews ● Int scalar common​

Maximum number of views allowed. Null means unlimited.

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

ID of the shared resource.

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

Type of the shared resource.

ShareLink.token ● String! non-null scalar common​

Token that grants access to the resource.

ShareLink.updatedAt ● ISO8601DateTime! non-null scalar common​

When the link was last updated.

ShareLink.url ● String! non-null scalar common​

Relative public URL for the link.

ShareLink.viewCount ● Int! non-null scalar common​

Number of times the link has been viewed.

Returned By​

createShareLink mutation ● revokeShareLink mutation ● shareLinks query