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

Function: readRelations()

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

List all Relations that exist in Directus.

Type parameters

• Schema extends object

Returns

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

An array of up to limit Relation objects. If no items are available, data will be an empty array.

Source

rest/commands/read/relations.ts:17