TypeScript API / laikacms/documents / ListRecordsOptions

Interface: ListRecordsOptions

Properties

depth

depth: number;

---

folder?

optional folder?: string;

Scope the listing to one collection (<collection> or <collection>/<subfolder>; the first path segment selects the collection). Omit (or pass an empty string) to list the root: each document collection surfaces as a folder record (a directory listing), rather than the records inside it.

---

pagination

pagination: 
  | {
  page: number;
  perPage?: number;
}
  | {
  before?: string;
  perPage?: number;
}
  | {
  after?: string;
  perPage?: number;
}
  | {
  limit?: number;
  offset: number;
};

---

statuses?

optional statuses?: string[];

---

type?

optional type?: "published" | "unpublished";