Skip to content

Commit 064055d

Browse files
Merge pull request #385 from kinde-oss/Fix/Search-user-via-PI
Minor content fix
2 parents e8e3b83 + 38de877 commit 064055d

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/content/docs/developer-tools/kinde-api/search-users-via-api.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,19 @@ relatedArticles:
99
- 601dd8c5-6ee1-474f-ad36-201e65280462
1010
---
1111

12-
You can search and filters users via the Kinde Management API. You might need to do this to isolate users with specific properties defined, for example, to find users in a particular city.
12+
You can search users and filter results via the Kinde Management API. You might need to do this to isolate users with specific properties defined, for example, to find users in a particular city.
1313

1414
## Make an API search request
1515

16-
Use the following `GET` request: `/api/v1/search/users?query=searchterm&filterA=X&filterB=Y`
16+
Search with `GET` request: `/api/v1/search/users?query=searchterm`
1717

18-
The `query=` part is where you add filters and search terms. For example,use `/api/v1/search/users?query=properties[kp_user_city]=Sydney` to find users from Sydney based on the `kp_user_city` property.
18+
Add additional filters to the request: `&filterA=X&filterB=Y`
19+
20+
Search and filter: GET `/api/v1/search/users?query=searchterm&filterA=X&filterB=Y`
21+
22+
The query= part is for searching by user name or email, additional filters can be applied separately. For example, use /api/v1/search/users?query=*&properties[kp_user_city]=Sydney to find all users from Sydney based on the kp_user_city property.
23+
24+
Here's some examples of search requests with different filter types.
1925

2026
- Filter for users with multiple properties using AND(&) statements.
2127

0 commit comments

Comments
 (0)