---
title: "Get a company by slug"
method: GET
path: "/api/companies/{slug}"
---

# Get a company by slug

`GET /api/companies/{slug}`

## Request

- Base URL: `https://gstcranes.com`
- URL: `https://gstcranes.com/api/companies/{slug}`
- Auth: none declared

## Path parameters

- `slug` string, required

## Headers

- `GST-API-Version` string

## Response `200`

Company detail

- PublicCompany
  - `id` integer, required
  - `slug` string, required
  - `name` string, required
  - `description` string, nullable
  - `logo_url` string, nullable
  - `cover_image_url` string, nullable
  - `website` string, nullable
  - `phone` string, nullable
  - `whatsapp` string, nullable
  - `address_line1` string, nullable
  - `address_line2` string, nullable
  - `city` string, nullable
  - `state_region` string, nullable
  - `country` string, required
  - `postal_code` string, nullable
  - `lat` number, required
  - `lon` number, required
  - `tier` 'free' | 'featured'
  - `services` string[], required
  - `fleet_highlights` FleetHighlight[], required
    - `brand` string, nullable
    - `model` string, nullable
    - `capacity_t` number, nullable
    - `boom_type` string, nullable
    - `max_height_m` number, nullable

## Other responses

- `404`: Resource not found.
- `429`: Rate limit exceeded.
- `500`: Unexpected server error.
- `default`: Machine-readable API error.

---

[API](https://skmtc.dev/gstcranes/apis/gst-cranes-companies-api.md) · [All operations](https://skmtc.dev/gstcranes/apis/gst-cranes-companies-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gstcranes/apis/gst-cranes-companies-api/revisions/0248d238b736?raw)