organizations

Bootstrap My Organization

Lazily bootstrap the caller’s own organization, healing a missing row.

Additive, idempotent companion to the Clerk organization.created webhook. Deliberately exempt from the bootstrap-ready gate so a caller whose shared-namespace row was never created — local development with no inbound tunnel, or a production webhook outage — can drive its own provisioning. The row is created if absent and left untouched if present, so a webhook and this endpoint racing converge on one row.

A missing row is inserted with the organization’s name and slug as the identity provider reports them, the same values the webhook carries. A present row is answered without that lookup.

When the row is missing and its name and slug are temporarily unavailable, the call answers 503 with Retry-After and creates nothing, so the caller retries after the delay. When the lookup is refused outright, the call answers 500, creates nothing, and a retry cannot succeed.

Returns: Public status envelope, identical in shape to GET /me/status, reporting the row’s status after the bootstrap request is queued.

POST

organizations

bootstrap

Bootstrap My Organization

curl --request POST \
  --url https://api.example.com/organizations/me/bootstrap

const options = {method: 'POST'};

fetch('https://api.example.com/organizations/me/bootstrap', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/organizations/me/bootstrap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/organizations/me/bootstrap"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/organizations/me/bootstrap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "bootstrapping"
}

Response

Successful Response

Public bootstrap status payload for the authenticated organization.

Collapses the internal :class:OrganizationStatus lifecycle into three user-facing states the web and CLI clients can switch on without learning about intermediate internal states:

"bootstrapping" — the organization's platform stack is still being provisioned. Clients should keep polling and block access to tenant-scoped routes.
"ready" — every seeded platform resource has reached READY. The client can stop polling and render the app.
"failed" — the organization is in a terminal non-ready state (BOOTSTRAP_FAILED, DEACTIVATING, or DELETED). The client should stop polling and display a support-contact screen.

Deliberately minimal: no resource detail, no error text, no retry-after. The bootstrap gate already returns a structured 503 envelope for the tenant-scoped routes — this endpoint exists purely to tell clients when to stop polling.

status

enum<string>

required

Available options:

bootstrapping,

ready,

failed

Bootstrap My Organization

curl --request POST \
  --url https://api.example.com/organizations/me/bootstrap

const options = {method: 'POST'};

fetch('https://api.example.com/organizations/me/bootstrap', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/organizations/me/bootstrap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/organizations/me/bootstrap"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/organizations/me/bootstrap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "bootstrapping"
}

Overview

API Reference

api-keys

auth

canvas

events

graph

files

ops

organizations

patches

projects

providers

resources

webhooks

Bootstrap My Organization

Response