---
title: "Returns a page of holdings recognised by the system"
method: POST
path: "/api/holdings"
tags: ["Holdings"]
---

# Returns a page of holdings recognised by the system

`POST /api/holdings`

There are multiple possible parameters to this call, but only some of them may be used at any time.

 When no parameters are specified, every holding in the system is returned.

 Searchterm and keyword behave independently, matches to either will cause a holding to be returned.

 If Searchterm is not specified then searchproperty will be ignored.

 If the keyword parameter is exactly the string "{searchterm}" then the searchterm is used to find

 matching keywords and matches to the keyword will be returned also

 and the FIRST matching keyword is used to identify holdings.

 Additionally, not more than one of the geographic options (gridid, region or the pair of regionclass and classitem) may be defined.

 If GridId is specified then region and regionclass/classitem will be ignored.

 If region is specified then regionclass/classitem willl be ignored

 If regionclass is specified, then the classitem must be specified also.

 Note that, as of this release, regionclass and classitem do not have any effect on the result set.

## Query parameters

- `page` integer
- `resultsPerPage` integer
- `searchterm` string
- `keyword` string
- `gridid` integer
- `region` string
- `regionclass` string
- `classitem` string
- `searchproperty` string
- `status` string
- `parent` integer
- `datefield` string
- `start` string
- `end` string
- `types` string
- `enableThesaurus` boolean

## Response `200`

Ok

---

[API](https://skmtc.net/cefas/apis/data-portal.md) · [All operations](https://skmtc.net/cefas/apis/data-portal/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cefas/data-portal/revisions/1ff904b61926/schema)