Search users via the Kinde API

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.

Make an API search request

Link to this section

Search with GET request: /api/v1/search/users?query=searchterm

Add additional filters to the request: &filterA=X&filterB=Y

Search and filter: GET /api/v1/search/users?query=searchterm&filterA=X&filterB=Y

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.

Here’s some examples of search requests with different filter types.

• Filter for users with multiple properties using AND(&) statements.

  /api/v1/search/users?query=properties[kp_usr_last_name]=Swan&properties[kp_usr_industry]=Construction

• Filter for users with any property filter using OR(comma) statements.

  /api/v1/search/users?query=properties[kp_usr_last_name]=Hornet,Swan

• Use a combination of filters.

  /api/v1/search/users?query=properties[kp_usr_last_name]=Hornet,Swan&properties[kp_usr_industry]=Construction&expand=identities,properties

• Wildcards can also be used.

  /api/v1/search/users?query=*&properties[kp_usr_middle_name]=Hornet,Swan&properties[kp_usr_industry]=Construction&expand=identities,properties

Example response

Link to this section

{
  "code": "…",
  "message": "…",
  "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,
      "failed_sign_ins": 0,
      "last_signed_in": "2025-02-12T18:02:23.614638+00:00",
      "created_on": "2025-02-12T18:02:23.614638+00:00",
      "organizations": [
        "…"
      ],
      "identities": [
        {
          "type": "…",
          "identity": "…"
        }
      ],
      "properties": {
        "{{key}}": "…"
      },
      "api_scopes": [
        {
          "org_code": "…",
          "scope": "…",
          "api_id": "…"
        }
      ]
    }
  ]
}

Search users by last activity date

Link to this section

Search users based on last activity date using the active_since parameter in the GET /api/v1/users endpoint. This searches for users by their last login date, useful for identifying inactive accounts or targeting recently active users.

/api/v1/users?active_since=2024-01-01T00:00:00Z

The active_since parameter accepts an ISO 8601 formatted date/time string. Users with a last login date on or after the specified date will be returned.

Example response

Link to this section

{
  "code": "…",
  "message": "…",
  "users": [
    {
      "id": "…",
      "provided_id": "…",
      "email": "…",
      "phone": "…",
      "username": "…",
      "last_name": "…",
      "first_name": "…",
      "is_suspended": true,
      "picture": "…",
      "total_sign_ins": 1,
      "failed_sign_ins": 1,
      "last_signed_in": "…",
      "created_on": "…",
      "last_organization_sign_ins": [
        {
          "org_code": "org_d2d85014942",
          "last_signed_in": "2026-01-28T14:26:02.448856+00:00"
        }
      ],
      "organizations": [
        "…"
      ],
      "identities": [
        {
          "type": "…",
          "identity": "…"
        }
      ],
      "billing": {
        "customer_id": "customer_1245adbc6789"
      }
    }
  ],
  "next_token": "…"
}