72 lines
1.3 KiB
Markdown
72 lines
1.3 KiB
Markdown
# Get Tenant by Slug
|
|
|
|
**GET /api/v1/tenants/slug/{slug}**
|
|
|
|
Retrieve tenant information by tenant slug.
|
|
|
|
**Authentication**: Required (JWT Bearer token)
|
|
|
|
**Headers**:
|
|
- `Authorization: JWT {access_token}`
|
|
|
|
**URL Parameters**:
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|----------|-------------|
|
|
| slug | string | Yes | Tenant slug |
|
|
|
|
**Example Request**:
|
|
|
|
```bash
|
|
curl -X GET http://localhost:8000/api/v1/tenants/slug/techstart \
|
|
-H "Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
|
```
|
|
|
|
**Example Response** (200 OK):
|
|
|
|
```json
|
|
{
|
|
"id": "850e8400-e29b-41d4-a716-446655440000",
|
|
"name": "TechStart Inc",
|
|
"slug": "techstart",
|
|
"status": "active",
|
|
"created_at": "2024-10-24T00:00:00Z",
|
|
"updated_at": "2024-10-24T00:00:00Z"
|
|
}
|
|
```
|
|
|
|
**Error Responses**:
|
|
|
|
This endpoint returns errors in **RFC 9457 (Problem Details for HTTP APIs)** format.
|
|
|
|
**Content-Type**: `application/problem+json`
|
|
|
|
**401 Unauthorized**:
|
|
```json
|
|
{
|
|
"type": "about:blank",
|
|
"title": "Unauthorized",
|
|
"status": 401,
|
|
"detail": "Authentication required"
|
|
}
|
|
```
|
|
|
|
**404 Not Found**:
|
|
```json
|
|
{
|
|
"type": "about:blank",
|
|
"title": "Not Found",
|
|
"status": 404,
|
|
"detail": "Tenant not found"
|
|
}
|
|
```
|
|
|
|
**500 Internal Server Error**:
|
|
```json
|
|
{
|
|
"type": "about:blank",
|
|
"title": "Internal Server Error",
|
|
"status": 500,
|
|
"detail": "Failed to retrieve tenant"
|
|
}
|
|
```
|