API Reference

Krystal Identity API

Resources & Endpoints

Create organization

Creates a new organization for the authenticated user.

POST
https://identity.krystal.io/api/v1/organizations

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

properties Required

OrganizationCreateProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

validation_error

An error ocurred with the input provided

 422 Unprocessable Entity

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
        address1: String?
        address2: String?
        address3: String?
        address4: String?
        postcode: String?
        time_zone: String
        vat_number: String?
        owner_ids: [ String ]
    }
}