Tattoo Developers

https://docs.tattoo.dev/
Admin
This project provides developer documentation for TattooAPI, tattoo.co, and Studio OS, offering...
Tokens:71,538
Snippets:1,212
Trust Score:4.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET /api/v1/studios

Source: https://docs.tattoo.dev/api-reference/surface-map

Provides a projection for studio discovery.

```APIDOC
## GET /api/v1/studios

### Description
Studio discovery projection.

### Method
GET

### Endpoint
/api/v1/studios
```

--------------------------------

### GET /studios

Source: https://docs.tattoo.dev/authentication

Public endpoint to retrieve a list of studios.

```APIDOC
## GET /studios

### Description
Retrieves a list of studios. This endpoint is publicly accessible without authentication.

### Method
GET

### Endpoint
/studios
```

--------------------------------

### GET /api/v1/designs

Source: https://docs.tattoo.dev/api-reference/surface-map

Retrieves the public design projection.

```APIDOC
## GET /api/v1/designs

### Description
Public design projection only.

### Method
GET

### Endpoint
/api/v1/designs
```

--------------------------------

### Ontology Refinery Review Commands

Source: https://docs.tattoo.dev/guides/data-hydration-source-packs

Commands for refinery-based review and preview workflows.

```bash
npm run inventory:ontology-refinery
npm run generate:ontology-refinery-review-pack
npm run generate:ontology-refinery-law-promotion-preview
npm run verify:ontology-refinery-law-promotion-preview
```

--------------------------------

### Generate and Verify Wave F Preview Pack

Source: https://docs.tattoo.dev/guides/future-wave-gates

Commands to create and validate the internal artifact for public read previews. These must be run locally and ensure public activation remains disabled.

```bash
npm run generate:wave-f-public-read-preview-pack
```

```bash
npm run verify:wave-f-public-read-preview-pack
```

--------------------------------

### GET /api/v1/artists

Source: https://docs.tattoo.dev/api-reference/surface-map

Retrieves the runtime-backed artist catalog.

```APIDOC
## GET /api/v1/artists

### Description
Runtime-backed artist catalog.

### Method
GET

### Endpoint
/api/v1/artists
```

--------------------------------

### Fetch Public Studio Data

Source: https://docs.tattoo.dev/guides/current-api-recipes

Retrieve a list of studios using public discovery parameters.

```bash
curl "https://api.tattooapi.com/v1/studios?state=HI&limit=10"
```

--------------------------------

### GET /api/v1/portfolios

Source: https://docs.tattoo.dev/api-reference/surface-map

Retrieves the public creative projection of portfolios.

```APIDOC
## GET /api/v1/portfolios

### Description
Public creative projection only.

### Method
GET

### Endpoint
/api/v1/portfolios
```

--------------------------------

### Run Activation Readiness Verification

Source: https://docs.tattoo.dev/guides/future-wave-gates

Verification commands required to move a surface from preview to public status. All checks must return green.

```bash
verify:wave-d-runtime
```

```bash
verify:wave-e-operator
```

```bash
verify:wave-f-readiness
```

```bash
verify:future-waves-readiness
```

--------------------------------

### Authentication Headers

Source: https://docs.tattoo.dev/quickstart

Required headers for internal beta access using WorkOS tokens or API keys.

```bash
Authorization: Bearer YOUR_WORKOS_TOKEN
```

```bash
X-API-Key: YOUR_WORKOS_API_KEY
```

--------------------------------

### GET /api/v1/portfolios/{id}

Source: https://docs.tattoo.dev/api-reference/surface-map

Retrieves details for a specific portfolio.

```APIDOC
## GET /api/v1/portfolios/{id}

### Description
Public creative projection only.

### Method
GET

### Endpoint
/api/v1/portfolios/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the portfolio.
```

--------------------------------

### GET /api/v1/artists/{id}

Source: https://docs.tattoo.dev/api-reference/surface-map

Retrieves details for a specific artist.

```APIDOC
## GET /api/v1/artists/{id}

### Description
Runtime-backed artist detail.

### Method
GET

### Endpoint
/api/v1/artists/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the artist.
```

--------------------------------

### GET /studios

Source: https://docs.tattoo.dev/api-reference/studios/list

Retrieves a list of studios based on provided query parameters.

```APIDOC
## GET /studios

### Description
Fetch a paginated list of tattoo studios. This endpoint supports filtering by location, price, rating, and various flags.

### Method
GET

### Endpoint
/studios

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Default 1
- **limit** (integer) - Optional - Default 20, max 50
- **search** (string) - Optional - Name, description, or city search
- **city** (string) - Optional - Exact city filter
- **state** (string) - Optional - Exact state filter
- **price_range** (string) - Optional - Comma-separated $, $$, $$$, $$$$
- **rating** (number) - Optional - Minimum rating
- **verified** (boolean) - Optional - Filter by verification flag
- **featured** (boolean) - Optional - Filter by featured flag
- **latitude** (number) - Optional - Geographic search
- **longitude** (number) - Optional - Geographic search
- **radius** (number) - Optional - Geographic search
- **sort** (string) - Optional - Sorting controls
- **order** (string) - Optional - Sorting controls

### Response
#### Success Response (200)
- **data** (array) - List of studio objects
- **pagination** (object) - Pagination metadata
- **error** (null) - Error status

#### Response Example
{
  "data": [
    {
      "id": "uuid",
      "name": "Ink Masters Studio",
      "description": "Premier tattoo studio",
      "address": "123 Main Street",
      "city": "Los Angeles",
      "state": "CA",
      "country": "USA",
      "rating": 4.8,
      "review_count": 127,
      "specialties": [],
      "verified": false,
      "featured": false
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "error": null
}
```

--------------------------------

### GET /api/v1/designs/{id}

Source: https://docs.tattoo.dev/api-reference/surface-map

Retrieves details for a specific design.

```APIDOC
## GET /api/v1/designs/{id}

### Description
Public design projection only.

### Method
GET

### Endpoint
/api/v1/designs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the design.
```

--------------------------------

### GET /health

Source: https://docs.tattoo.dev/authentication

Public endpoint to check the health status of the API.

```APIDOC
## GET /health

### Description
Returns the health status of the API. This endpoint is publicly accessible without authentication.

### Method
GET

### Endpoint
/health
```

--------------------------------

### Attempt Gated Owner Write

Source: https://docs.tattoo.dev/guides/current-api-recipes

Demonstrates that owner mutations are currently gated until the write contract is live.

```bash
curl -X PATCH "https://api.tattooapi.com/v1/me/designs/design:example" \
  -H "Authorization: Bearer $WORKOS_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"publish_state":"published_public"}'
```
Tokens:
Raw