Users

Get users

Changed on

The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the page_size query string parameter.

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

Request

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

Query parameters

page_sizeinteger nullable

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

user_idstring nullable

Filter the results by User ID. The query string should be comma separated and url encoded.

next_tokenstring nullable

A string to get the next page of results if there are more results.

emailstring nullable

Filter the results by email address. The query string should be comma separated and url encoded.

usernamestring nullable

Filter the results by username. The query string should be comma separated and url encoded.

phonestring nullable

Filter the results by phone. The query string should be comma separated and url encoded.

expandstring nullable

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

has_organizationboolean nullable

Filter the results by if the user has at least one organization assigned.

active_sincestring date-time nullable

Filter the results to only include users who have been active since this date. Date should be in ISO 8601 format.

Response

Users successfully retrieved.

codestring

Response code.

messagestring

Response message.

next_tokenstring

Pagination token.

Example response

{
  "users": [
    {
      "last_organization_sign_ins": [
        {
          "org_code": "org_d2d85014942",
          "last_signed_in": "2026-01-28T14:26:02.448856+00:00"
        }
      ],
      "identities": [
        {
          "connection_id": "conn_019289347f1193da6c0e4d49b97b4bd2"
        }
      ],
      "billing": {
        "customer_id": "customer_1245adbc6789"
      }
    }
  ]
}

Changes

  • bfffc845554dRevision changes
    • info

      added the optional property //// to the response with the status

  • 857db89aee60Revision changes
    • info

      added the new optional query request parameter active_since

    • info

      added the optional property // to the response with the status