On this page

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

Function: readCollections()

readCollections<Schema>(): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusCollection<Schema>> extends FF ? MapFlatFields<DirectusCollection<Schema>, keyof DirectusCollection<Schema>, FF extends Record<string, string> ? FF : Record<string, string>> : never, Object>>[], Schema>

List the available collections.

Type parameters

• Schema extends object

Returns

RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusCollection<Schema>> extends FF ? MapFlatFields<DirectusCollection<Schema>, keyof DirectusCollection<Schema>, FF extends Record<string, string> ? FF : Record<string, string>> : never, Object>>[], Schema>

An array of collection objects.

Source

rest/commands/read/collections.ts:16