---
title: "Check whether an organization slug is free"
method: GET
path: "/organizations/slug-availability"
tags: ["organizations"]
---

# Check whether an organization slug is free

`GET /organizations/slug-availability`

## Request

- Base URL: `https://api.letsship.ai/v1`
- URL: `https://api.letsship.ai/v1/organizations/slug-availability`
- Auth: none declared

Says whether the slug is free. A taken slug comes with a free variant to offer instead. Pass orgId to rename that organization: its own slug counts as free.

## Query parameters

- `slug` string, required
- `orgId` string

## Response `200`

Availability

- SlugAvailabilityResponse
  - `slug` string, required
  - `available` boolean, required
  - `suggestion` string, nullable, required

## Other responses

- `400`: Not a valid slug
- `401`: Unauthenticated

---

[API](https://skmtc.dev/letsship/apis/ship-api.md) · [All operations](https://skmtc.dev/letsship/apis/ship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/letsship/apis/ship-api/revisions/e6eac1bcadd4?raw)