---
title: "GET /categories/letters"
method: GET
path: "/categories/letters"
tags: ["categories"]
---

# GET /categories/letters

`GET /categories/letters`

Returns list of letter categories

## Query parameters

- `with_total` boolean

## Response `200`

Returns list of letter categories

- EndpointsLetterCategories — Endpoints_LetterCategories model
  - `data` LetterCategoryEntity[]
    - `id` integer
    - `name` string
    - `display_name` string
    - `color` string
    - `is_type` string
    - `item_type` string
    - `position` integer
    - `title_formula` string
    - `body` string
    - `hide_in_reports` boolean
    - `hide_in_activities` boolean
    - `internal` boolean
    - `locked` boolean
    - `viewonly` boolean
    - `next_property_status_id` integer
    - `next_client_status_id` integer
    - `next_deal_stage_id` integer
    - `created_at` string
    - `updated_at` string
  - `total` integer — Show the total count of letter categories

## Other responses

- `400` — validation_error
- `401` — authentication_error
- `403` — authorization_error
- `404` — not_found_error
- `422` — validation_error
- `500` — internal_server_error

---

[API](https://skmtc.net/propstack/apis/propstack-api-v2-beta.md) · [All operations](https://skmtc.net/propstack/apis/propstack-api-v2-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/propstack/propstack-api-v2-beta/revisions/ae1e0fe6da1a/schema)