> For the complete documentation index, see [llms.txt](https://docs.osmosworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.osmosworks.com/api-reference/organizations.md).

# Organizations and onboarding

## Suggest a slug

Returns a suggested workspace slug based on a name.

* **Method:** `GET`
* **Path:** `/api/v1/organizations/slugs/suggest?name={name}`
* **Authentication:** None

## Check slug availability

* **Method:** `GET`
* **Path:** `/api/v1/organizations/slugs/{slug}/availability`
* **Authentication:** None

### Response

```json
{
  "status": "Success",
  "message": "Workspace URL is available.",
  "data": {
    "available": true,
    "slug": "acme-services"
  }
}
```

## Register an organization

Starts the onboarding process by sending a verification email.

* **Method:** `POST`
* **Path:** `/api/v1/organizations/register`
* **Authentication:** None

### Request body

```json
{
  "email": "ada@acme.example.com",
  "name": "Ada Lovelace",
  "password": "SecurePassword123!",
  "confirmPassword": "SecurePassword123!"
}
```

### Response

```json
{
  "status": "Success",
  "message": "We sent a setup link to your email. Click it to verify and set up your workspace."
}
```

## Verify email

Validates the setup link and sets an onboarding cookie.

* **Method:** `GET`
* **Path:** `/api/v1/organizations/verify?token={token}`
* **Authentication:** None

### Response

```json
{
  "status": "Success",
  "data": {
    "email": "ada@acme.example.com",
    "name": "Ada Lovelace",
    "verified": true,
    "token": "eyJ..."
  }
}
```

## Resend setup link

Requests a fresh setup link for an existing onboarding token.

* **Method:** `POST`
* **Path:** `/api/v1/organizations/resend-link`
* **Authentication:** None

```json
{
  "token": "existing-token"
}
```

## Create the workspace

Creates the tenant, founding admin, profile, and settings.

* **Method:** `POST`
* **Path:** `/api/v1/organizations/create`
* **Authentication:** Onboarding token cookie

### Request body

```json
{
  "slug": "acme-services",
  "organizationName": "Acme Services",
  "sector": "immigration",
  "staffCount": 5,
  "expectedCustomerVolume": 100
}
```

### Response

Returns `CreateOrganizationResponse` with tenant details and session handoff. Sets access and refresh cookies.

## Get onboarding progress

* **Method:** `GET`
* **Path:** `/api/v1/onboarding`
* **Authentication:** Onboarding token cookie or authenticated tenant admin

## Skip onboarding step

* **Method:** `POST`
* **Path:** `/api/v1/onboarding/steps/{stepKey}/skip`
* **Authentication:** Onboarding token cookie or authenticated tenant admin

## Payout account

### List banks

* **Method:** `GET`
* **Path:** `/api/v1/organizations/payment-account/banks?currency=NGN`
* **Authentication:** Tenant admin

### Setup payout account

* **Method:** `POST`
* **Path:** `/api/v1/organizations/payment-account`
* **Authentication:** Tenant admin

```json
{
  "bankCode": "057",
  "accountNumber": "1234567890"
}
```

### Get payout account

* **Method:** `GET`
* **Path:** `/api/v1/organizations/payment-account`
* **Authentication:** Tenant admin

## Public landing page

Returns the published landing page for a tenant.

* **Method:** `GET`
* **Path:** `/api/v1/organizations/{slug}/landing-page`
* **Authentication:** None


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.osmosworks.com/api-reference/organizations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.