POST/api/v1/create-org

Create an organisation

Creates a new organisation, the top-level entity that holds every workspace, member, and resource, and returns its id.

AccessRequires a signed-in caller

Send the organisation's name. Any signed-in user may make this call. The response reports Success and returns the new organisation's id as UID, using the capitalised field names this endpoint has kept.

Everything in SQRL is scoped to a workspace, so an organisation on its own holds nothing yet: create at least one workspace inside it with POST /api/v1/create-workspace, passing the UID above as org_uid, before there are vaults, tokens, or members to work with. Organisations covers what an organisation contains. A user who does not belong to an organisation yet can instead submit POST /api/v1/request-organisation, which staff review and act on by creating the organisation on approval.

Body parameters

org_namestringrequired

Name for the organisation, usually the company or institution it represents.

bash

curl -X POST "$SQRL_API/api/v1/create-org" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "org_name": "Northgate Treasury"
      }'

const res = await fetch(`${process.env.SQRL_API}/api/v1/create-org`, {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.SQRL_TOKEN}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    org_name: "Northgate Treasury",
  }),
});
const { Success, UID } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/create-org", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "org_name": "Northgate Treasury",
    }))
    .send()
    .await?;

Response200 OK

{
"Success": true,
"UID": 118
}

Was this page helpful?