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 / readFieldsByCollection

Function: readFieldsByCollection() ​

readFieldsByCollection<Schema>(collection): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusField<Schema>> extends FF ? MapFlatFields<DirectusField<Schema>, keyof DirectusField<Schema>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, {}>[K] }>[], Schema>

Defined in: rest/commands/read/fields.ts:27

List the available fields in a given collection.

Type Parameters ​

• Schema

Parameters ​

collection ​

string

The primary key of the field

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusField<Schema>> extends FF ? MapFlatFields<DirectusField<Schema>, keyof DirectusField<Schema>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, {}>[K] }>[], Schema>

Throws ​

Will throw if collection is empty