Sign in
Organizations

Get organization

Changed on

Retrieve organization details by code.

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

Request

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

Query parameters

codestring required
Example:org_1ccfb819462

The organization's code.

expandstring
Example:billing

Additional data to include in the response. Allowed value: "billing".

Response

Organization successfully retrieved.

codestring

The unique identifier for the organization.

namestring

The organization's name.

handlestring nullable

A unique handle for the organization - can be used for dynamic callback urls.

is_defaultboolean

Whether the organization is the default organization.

external_idstring nullable

The organization's external identifier - commonly used when migrating from or mapping to other systems.

is_auto_membership_enabledboolean

If users become members of this organization when the org code is supplied during authentication.

logostring nullable

The organization's logo URL.

logo_darkstring nullable

The organization's logo URL to be used for dark themes.

favicon_svgstring nullable

The organization's SVG favicon URL. Optimal format for most browsers

favicon_fallbackstring nullable

The favicon URL to be used as a fallback in browsers that don't support SVG, add a PNG

allowed_domainsstring[]

Domains allowed for self-sign up to this environment. Empty array means no restrictions.

button_border_radiusinteger nullable

The border radius for buttons. Value is px, Kinde transforms to rem for rendering

card_border_radiusinteger nullable

The border radius for cards. Value is px, Kinde transforms to rem for rendering

input_border_radiusinteger nullable

The border radius for inputs. Value is px, Kinde transforms to rem for rendering

theme_code'light' | 'dark' | 'user_preference'

Whether the environment is forced into light mode, dark mode or user preference

color_scheme'light' | 'dark' | 'light dark'

The color scheme for the environment used for meta tags based on the theme code

created_onstring

Date of organization creation in ISO 8601 format.

is_allow_registrationsboolean nullable

Deprecated - Use 'is_auto_membership_enabled' instead

sender_namestring nullable

The name of the organization that will be used in emails

sender_emailstring nullable

The email address that will be used in emails. Requires custom SMTP to be set up.

is_suspendedboolean

Whether the organization is currently suspended or not.

suspended_onstring nullable

The date the organization was suspended in ISO 8601 format. Null if not suspended.

Example response

{
  "code": "org_1ccfb819462",
  "name": "Acme Corp",
  "handle": "acme_corp",
  "external_id": "some1234",
  "is_auto_membership_enabled": true,
  "logo": "https://yoursubdomain.kinde.com/logo?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d",
  "logo_dark": "https://yoursubdomain.kinde.com/logo_dark?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d",
  "favicon_svg": "https://yoursubdomain.kinde.com/favicon_svg?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d",
  "favicon_fallback": "https://yoursubdomain.kinde.com/favicon_fallback?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d",
  "allowed_domains": [
    "https://acme.kinde.com",
    "https://acme.com"
  ],
  "link_color": {
    "raw": "#0056F1",
    "hex": "#0056F1",
    "hsl": "hsl(220, 100%, 50%)"
  },
  "background_color": {
    "raw": "#ffffff",
    "hex": "#ffffff",
    "hsl": "hsl(0, 0%, 100%)"
  },
  "button_color": {
    "raw": "#0056F1",
    "hex": "#0056F1",
    "hsl": "hsl(220, 100%, 50%)"
  },
  "button_text_color": {
    "raw": "#ffffff",
    "hex": "#ffffff",
    "hsl": "hsl(0, 0%, 100%)"
  },
  "link_color_dark": {
    "raw": "#0056F1",
    "hex": "#0056F1",
    "hsl": "hsl(220, 100%, 50%)"
  },
  "background_color_dark": {
    "raw": "#0056F1",
    "hex": "#0056F1",
    "hsl": "hsl(220, 100%, 50%)"
  },
  "button_text_color_dark": {
    "raw": "#0056F1",
    "hex": "#0056F1",
    "hsl": "hsl(220, 100%, 50%)"
  },
  "button_color_dark": {
    "raw": "#0056F1",
    "hex": "#0056F1",
    "hsl": "hsl(220, 100%, 50%)"
  },
  "button_border_radius": 8,
  "card_border_radius": 16,
  "input_border_radius": 4,
  "created_on": "2021-01-01T00:00:00Z",
  "is_allow_registrations": true,
  "sender_name": "Acme Corp",
  "sender_email": "hello@acmecorp.com",
  "suspended_on": "2021-01-01T00:00:00Z",
  "billing": {
    "agreements": [
      {
        "plan_code": "pro",
        "agreement_id": "agreement_a1234b"
      }
    ]
  }
}

Changes

  • bfffc845554dRevision changes
    • breaking

      the query request parameter code became required

  • b3e096c729c2Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status