Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / readShareInfo

Function: readShareInfo() ​

readShareInfo<Schema>(id): RestCommand<{ collection: string; date_end: null | string; date_start: null | string; id: string; item: string; max_uses: null | number; password: null | string; times_used: null | number; }, Schema>

Defined in: rest/commands/utils/shares.ts:48

Allows unauthenticated users to retrieve information about the share.

Type Parameters ​

• Schema

Parameters ​

id ​

string

Primary key of the share you're viewing.

Returns ​

RestCommand<{ collection: string; date_end: null | string; date_start: null | string; id: string; item: string; max_uses: null | number; password: null | string; times_used: null | number; }, Schema>

The share objects for the given UUID, if it's still valid.