Skip to content
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 / readItems

Function: readItems()

readItems<Schema, Collection, TQuery>(collection, query?): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>, Exclude<UnpackList<Mutable<TQuery["fields"]>>, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : AllKeys<UnpackList<UnpackList<Mutable<TQuery["fields"]>>> extends Field ? Field extends object ? Field : never : never>>>, FF extends Record<string, string> ? FF : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>> ? Extract<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>[Field], null | (RelatedCollection extends any[] ? HasManyToAnyRelation<RelatedCollection> extends never ? null | ApplyNestedQueryFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field]>[] : ApplyManyToAnyFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field], UnpackList<RelatedCollection>>[] : ApplyNestedQueryFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field]>), RelatedCollection extends any[] ? HasManyToAnyRelation<RelatedCollection> extends never ? null | ApplyNestedQueryFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field]>[] : ApplyManyToAnyFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field], UnpackList<RelatedCollection>>[] : ApplyNestedQueryFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field]>> : never : never }>>[], Schema>

List all items that exist in Directus.

Type parameters

Schema extends object

Collection extends string | number | symbol

TQuery extends Query<Schema, CollectionType<Schema, Collection>>

Parameters

collection: Collection

The collection of the items

query?: TQuery

The query parameters

Returns

RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>, Exclude<UnpackList<Mutable<TQuery["fields"]>>, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : AllKeys<UnpackList<UnpackList<Mutable<TQuery["fields"]>>> extends Field ? Field extends object ? Field : never : never>>>, FF extends Record<string, string> ? FF : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>> ? Extract<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<Schema[Collection]> extends object ? object & UnpackList<Schema[Collection]> : never : never>>[Field], null | (RelatedCollection extends any[] ? HasManyToAnyRelation<RelatedCollection> extends never ? null | ApplyNestedQueryFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field]>[] : ApplyManyToAnyFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field], UnpackList<RelatedCollection>>[] : ApplyNestedQueryFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field]>), RelatedCollection extends any[] ? HasManyToAnyRelation<RelatedCollection> extends never ? null | ApplyNestedQueryFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field]>[] : ApplyManyToAnyFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field], UnpackList<RelatedCollection>>[] : ApplyNestedQueryFields<Schema, RelatedCollection, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>>[Field]>> : never : never }>>[], Schema>

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

Throws

Will throw if collection is a core collection

Throws

Will throw if collection is empty

Source

rest/commands/read/items.ts:22