API Reference

Krystal Identity API

Resources & Endpoints

Get info about any organization

Returns information for the requested organization.

GET
https://identity.krystal.io/api/v1/client/organizations/{organization}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

organization Required

Organization Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    organization: Organization {
        id: String
        name: String
        identifier: String
        time_zone: String?
        updated_at: Unix Timestamp
        two_factor_required: Boolean
        managed: Boolean
        parent_id: String?
        users: [ OrganizationUser {
            user_id: String
            organization_id: String
            owner: Boolean
            roles: [ String? ]
        } ]
        policy: OrganizationPolicy? {
            name: String
            type: OrganizationPolicyTypeEnum
            limits: [ OrganizationPolicyLimit {
                key: String
                value: String?
                value_type: OrganizationPolicyFieldValueTypeEnum
                label: String
                suffix: String?
                sub_text: String?
            } ]
        }
    }
}