Retrieving catalogs by filter with total count
GET {{api-url}}/catalog/{{tenant}}/catalogs?visibilityFrom=2022-01-14&visibilityTo=2025-01-24&metadataUpdatedAt=2022-01-01&pageNumber=1&pageSize=60&description.en=description&sort=name.en,description.en:asc&name.en=Sample
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
visibilityFrom | string | ||
visibilityTo | string | ||
metadataUpdatedAt | string | ||
pageNumber | number | ||
pageSize | number | ||
description.en | string | ||
sort | string | ||
name.en | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept-Language | string | ||
X-Total-Count | boolean | This flag specifies if the API client should receive a X-Total-Count header with the total number of elements that match the search filter. |
RESPONSES
status: OK
[{"id":"6294b0556ff98f76f4e2e509","name":{"en":"Sample catalog"},"description":{"en":"Basic catalog description"},"status":"not_visible","visibility":{"visible":true,"from":"2022-01-24T12:12:12.623Z","to":"2022-06-24T12:12:12.616Z"},"publishedSites":["Main"],"metadata":{"version":1,"updatedAt":"2022-05-30T11:53:57.093Z","createdAt":"2022-05-30T11:53:57.093Z"},"categoryIds":["8b85d8f2-343b-4010-8157-05fdf3001524"]},{"id":"null","name":{"en":"Sample catalog after update"},"description":{"en":"Catalog description"},"status":"visible","visibility":{"visible":true,"from":"2022-01-24T12:12:12.616Z","to":"2023-03-24T12:12:12.616Z"},"publishedSites":["main"],"metadata":{"version":2,"updatedAt":"2023-01-19T07:00:10.713Z","createdAt":"2023-01-19T06:58:57.819Z"},"categoryIds":["8bb62907-014b-47a3-a039-20734369bc4e"]}]