Get Your Entity Documents
ℹ️
This page haven't been written yet. Help us write it by contributing!
Endpoint
GET: <BACKEND_URL>/store/ultimate-entities/<ULTIMATE_ENTITY_ID>/documents
Path Variables
<BACKEND_URL>: your medusa backend URL.<ULTIMATE_ENTITY_ID>: the entity ID.<DOCUMENT_ID>: the entity document ID.
Parameters
| Param | Type | Details |
|---|---|---|
<field> | string | string[] | Any of your document field to filter on, example: title=brand-name-1,brand-name-2: will return all documents with one of this titles |
| limit | number | The number of products to skip when retrieving the documents |
| offset | number | How much rows to skip. |
| order | string | string[] | A document field(s) to sort-order the retrieved documents by. |
| q | string | Used to search on documents fields specified in the @UltimateEntity decorator |
Return Value
{
documents: {
id: string;
// other fields of your entity
created_at: Date;
updated_at: Date;
deleted_at: Date;
}[];
}