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

Function: readRelation() ​

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

List an existing Relation by collection and field name.

Type Parameters ​

• Schema

Parameters ​

• collection: string

The collection

• field: string

The field

Returns ​

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

Returns a Relation object if a valid collection and field name was provided.

Throws ​

Will throw if collection is empty

Throws ​

Will throw if field is empty

Defined in ​

rest/commands/read/relations.ts:40