---
title: "Check if a farm name is available"
method: GET
path: "/api/v1/farms/availability"
tags: ["farms"]
---

# Check if a farm name is available

`GET /api/v1/farms/availability`

## Request

- Base URL: `http://localhost:3000`
- URL: `http://localhost:3000/api/v1/farms/availability`
- Auth: HTTP bearer

Check if a farm name is available

## Query parameters

- `name` string, required
- `excludeApplicationId` string

## Response `200`

Default Response

- object
  - `success` true, required
  - `data` object, required
    - `available` boolean
    - `name` string
    - `reason` string
    - `conflictingName` string
    - `similarNames` object[]
      - `farmName` string
      - `similarity` number
      - `username` string
      - `source` 'user' | 'application'
  - `meta` object, required
    - `timestamp` number, required

## Other responses

- `400`: Farm name must be at least 3 characters
- `401`: Default Response
- `403`: Default Response
- `500`: Default Response

---

[API](https://skmtc.dev/farmersonly/apis/farmersonly-club-api.md) - [All operations](https://skmtc.dev/farmersonly/apis/farmersonly-club-api/llms.txt) - [OpenAPI document](https://skmtc.dev/farmersonly/apis/farmersonly-club-api/revisions/b4fa9123ba90?raw)
