POST/api/v1/request-organisation

Request an organisation

Submits a request for a new organisation and its first workspace, for a signed-in user who does not belong to an organisation yet, and stores it for staff review.

AccessRequires a signed-in caller

This is the route for a signed-in user with no organisation of their own. Nothing is created when you call it: the request is recorded with your contact details and the names you want, and staff review it and create the organisation on approval. You may have one open request at a time, so check GET /api/v1/get-my-organisation-request before submitting another. A user who already belongs to an organisation creates further ones directly with POST /api/v1/create-org.

monthly_volume is a tier key rather than a figure, for example "1m_to_10m", and referral_source_detail is required when referral_source is "other". The stored request comes back as request, an OnboardingRequest documented under Shared objects.

Body parameters

first_namestringrequired

Your first name.

last_namestringrequired

Your surname.

work_emailstringrequired

Your work email address, which can differ from the email on your account.

messaging_platformstringrequired

The messaging platform to contact you on. Either telegram or whatsapp.

messaging_handlestringrequired

Your handle on that platform.

monthly_volumestringrequired

The volume band you expect to operate at, sent as a tier key such as 1m_to_10m.

referral_sourcestringrequired

How you came to SQRL, for example conference.

referral_source_detailstringoptional

Further detail on how you came to SQRL. Required when referral_source is other.

org_namestringrequired

The name you want for the organisation.

workspace_namestringrequired

The name you want for its first workspace.

bash

curl -X POST "$SQRL_API/api/v1/request-organisation" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "first_name": "Ada",
        "last_name": "Okafor",
        "work_email": "ada.okafor@northgate.example",
        "messaging_platform": "telegram",
        "messaging_handle": "@ada_okafor",
        "monthly_volume": "1m_to_10m",
        "referral_source": "conference",
        "org_name": "Northgate Treasury",
        "workspace_name": "Treasury Operations"
      }'

const res = await fetch(`${process.env.SQRL_API}/api/v1/request-organisation`, {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.SQRL_TOKEN}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    first_name: "Ada",
    last_name: "Okafor",
    work_email: "ada.okafor@northgate.example",
    messaging_platform: "telegram",
    messaging_handle: "@ada_okafor",
    monthly_volume: "1m_to_10m",
    referral_source: "conference",
    org_name: "Northgate Treasury",
    workspace_name: "Treasury Operations",
  }),
});
const { success, request } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/request-organisation", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "first_name": "Ada",
        "last_name": "Okafor",
        "work_email": "ada.okafor@northgate.example",
        "messaging_platform": "telegram",
        "messaging_handle": "@ada_okafor",
        "monthly_volume": "1m_to_10m",
        "referral_source": "conference",
        "org_name": "Northgate Treasury",
        "workspace_name": "Treasury Operations",
    }))
    .send()
    .await?;

Response200 OK

{
"success": true,
"request": {
  "uid": 91,
  "requester_uuid": 4021,
  "requester_email": "operator@example.com",
  "first_name": "Ada",
  "last_name": "Okafor",
  "work_email": "ada.okafor@northgate.example",
  "messaging_platform": "telegram",
  "messaging_handle": "@ada_okafor",
  "monthly_volume": "1m_to_10m",
  "referral_source": "conference",
  "referral_source_detail": { "String": "", "Valid": false },
  "org_name": "Northgate Treasury",
  "workspace_name": "Treasury Operations",
  "status": "pending",
  "review_note": { "String": "", "Valid": false },
  "approved_by_email": { "String": "", "Valid": false },
  "approved_at": { "Time": "0001-01-01T00:00:00Z", "Valid": false },
  "was_created": false,
  "created_org_uid": { "Int64": 0, "Valid": false },
  "submitted_at": "2026-07-30T13:05:27Z",
  "updated_at": "2026-07-30T13:05:27Z"
}
}

#What happens next

Staff review the request. Read its progress with GET /api/v1/get-my-organisation-request: status is pending until it is reviewed, review_note carries the reviewer's note, and was_created with created_org_uid records the organisation created on approval, which is the id you then pass as org_uid to POST /api/v1/create-workspace.

Was this page helpful?