Sign in
Organizations

Get organizations

Changed on

Get a list of organizations.

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

Request

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

Query parameters

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

Field and order to sort the result by.

page_sizeinteger nullable

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

next_tokenstring nullable

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

Response

Organizations successfully retreived.

codestring

Response code.

messagestring

Response message.

next_tokenstring

Pagination token.

Example response

{
  "code": "OK",
  "message": "Success",
  "organizations": [
    {
      "code": "org_1ccfb819462",
      "name": "Acme Corp",
      "handle": "acme_corp",
      "external_id": "some1234",
      "is_auto_membership_enabled": true
    }
  ],
  "next_token": "Mjo5Om1hbWVfYZNj"
}

Changes

  • 2d09422a38e4Revision changes
    • breaking

      added the new required header request parameter Accept to all path's operations

    • info

      the endpoint scheme security kindeBearerAuth was added to the API

    • info

      the endpoint scheme security ManagementAPI was removed from the API

  • 6b937fa6da4eRevision changes
    • breaking

      removed the media type application/json; charset=utf-8 for the response with the status

    • breaking

      the response property // became nullable for the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

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

    • info

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