Sign in
Organizations

Get organization users

Changed on

Get user details for all members of an organization.

<div> <code>read:organization_users</code> </div>
get/api/v1/organizations/{org_code}/users

Request

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

Path parameters

org_codestring required
Example:org_1ccfb819462

The organization's code.

Query parameters

sort'name_asc' | 'name_desc' | 'email_asc' | 'email_desc' nullable
Example:email_asc

Field and order to sort the result by.

page_sizeinteger nullable
Example:10

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

next_tokenstring nullable
Example:MTo6OmlkX2FzYw==

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

permissionsstring
Example:admin

Filter by user permissions comma separated (where all match)

rolesstring
Example:manager

Filter by user roles comma separated (where all match)

Response

A successful response with a list of organization users or an empty list.

codestring

Response code.

messagestring

Response message.

next_tokenstring

Pagination token.

Example response

{
  "code": "OK",
  "message": "Success",
  "organization_users": [
    {
      "id": "kp:97c2ba24217d48e3b96a799b76cf2c74",
      "email": "john.snow@example.com",
      "full_name": "John Snow",
      "last_name": "Snow",
      "first_name": "John",
      "picture": "https://example.com/john_snow.jpg",
      "joined_on": "2021-01-01T00:00:00Z",
      "last_accessed_on": "2022-01-01T00:00:00Z",
      "roles": [
        "admin"
      ]
    }
  ]
}

Changes

  • bfffc845554dRevision changes
    • breaking

      removed the enum value id_asc from the query request parameter sort

    • breaking

      removed the enum value id_desc from the query request parameter sort

  • 0c5023c4d856Revision changes
    • info

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

    • info

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