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<object, Schema>

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<object, Schema>

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

collection ​

collection: string

date_end ​

date_end: null | string

date_start ​

date_start: null | string

id ​

id: string

item ​

item: string

max_uses ​

max_uses: null | number

password ​

password: null | string

times_used ​

times_used: null | number

Defined in ​

rest/commands/utils/shares.ts:48