Skip to content

Commit cae5d74

Browse files
committed
feat: document search result set limits
1 parent 9d4fd72 commit cae5d74

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/kratos/manage-identities/search/identity-search-api.mdx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ import Help from '@site/docs/_common/need-help.mdx'
2929

3030
## Getting started
3131

32-
We recommend using the [Typesense SDKs](https://typesense.org/docs/29.0/api/api-clients.html) for your preferred language to
33-
interact with the advanced identity search API. Pass your [Ory Network API key](/concepts/personal-access-token) where you would
34-
normally pass the Typesense API key, use the following base URL:
32+
Ory exposes an advanced Identity Search API that is compatible with the Typesense search protocol. You can use existing Typesense
33+
SDKs to interact with it. Pass your [Ory Network API key](/concepts/personal-access-token) where you would normally pass the
34+
Typesense API key, and use the following base URL:
3535

3636
```shell
3737
https://{your-ory-slug}.projects.oryapis.com/admin/preview/search/v0beta1
@@ -105,6 +105,13 @@ possible.
105105

106106
:::
107107

108+
## Search result set limit
109+
110+
The identity search API does not support pagination (unlike the List Identities API) and will return a maximum of 1,000 results
111+
per request. If you are frequently hitting this limit, consider refining your search queries to reduce the number of results
112+
returned. To paginate through _all_ your identities, use the
113+
[List Identities API](/reference/api#tag/identity/operation/listIdentities).
114+
108115
## Consistency and availability
109116

110117
The search index powering advanced identity search is eventually consistent with the main identity store. This means that there

0 commit comments

Comments
 (0)