Sign in
Search

Search users

Changed on

Search for users based on the provided query string. Set query to '*' to filter by other parameters only. The number of records to return at a time can be controlled using the page_size query string parameter.

<div> <code>read:users</code> </div>
get/api/v1/search/users

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/search/users
  • Auth: HTTP bearer

Query parameters

page_sizeinteger nullable

Number of results per page. Defaults to 10 if parameter not sent.

querystring nullable

Search the users by email or name. Use '*' to search all.

api_scopesstring nullable

Search the users by api scopes.

propertiesobject
starting_afterstring nullable

The ID of the user to start after.

ending_beforestring nullable

The ID of the user to end before.

expandstring nullable

Additional data to include in the response. One or more of (comma-separated): "organizations", "identities", "properties".

Response

Users successfully retrieved.

codestring

Response code.

messagestring

Response message.

Example response

{
  "results": [
    {
      "id": "kp_0ba7c433e5d648cf992621ce99d42817",
      "provided_id": "U123456",
      "email": "user@domain.com",
      "username": "john.snow",
      "last_name": "Snow",
      "first_name": "John",
      "is_suspended": true,
      "picture": "https://example.com/john_snow.jpg",
      "total_sign_ins": 1,
      "last_signed_in": "2025-02-12T18:02:23.614638+00:00",
      "created_on": "2025-02-12T18:02:23.614638+00:00"
    }
  ]
}

Changes