---
title: "Preview the slug the API would derive from an org name (onboarding helper)"
method: GET
path: "/organizations/slug-preview"
tags: ["organizations"]
---

# Preview the slug the API would derive from an org name (onboarding helper)

`GET /organizations/slug-preview`

## Request

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

## Query parameters

- `name` string, required

## Response `200`

Derived slug

- SlugPreviewResponse
  - `slug` string, required

## Other responses

- `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)