---
title: "get all numberings related to a category"
method: GET
path: "/api/numberings/cat/{id}"
tags: ["Numbering"]
---

# get all numberings related to a category

`GET /api/numberings/cat/{id}`

## Path parameters

- `id` integer, required

## Response `200`

OK

- GanjoorNumbering[]
  - `id` integer — id
  - `name` string, nullable — name
  - `startCatId` integer — starting category id
  - `startCat` GanjoorCat — Ganjoor Category
    - `id` integer — id
    - `poetId` integer — poet_id
    - `poet` GanjoorPoet — Ganjoor Poet
      - `id` integer — id
      - `name` string, nullable — name
      - `description` string, nullable — description
      - `nickname` string, nullable — short name
      - `rImage` RImage — Image Files
        - `id` string, uuid — Id
        - `originalFileName` string, nullable — Original File Name
        - `contentType` string, nullable — content type
        - `fileSizeInBytes` integer — Original Image File Size In Byte
        - `imageWidth` integer — Original Image Width
        - `imageHeight` integer — Original Image Height
        - `folderName` string, nullable — پوشه محل ذخیره تصویر
        - `storedFileName` string, nullable — نام فایل ذخیره شده با بالاترین کیفیت
        - `dataTime` string, date-time — datetime
        - `lastModified` string, date-time — Last Modified for caching purposes
      - `rImageId` string, uuid, nullable — user image id
      - `published` boolean — published on website
      - `birthYearInLHijri` integer — birth year in lunar hijri
      - `deathYearInLHijri` integer — death year in lunar hijri
      - `pinOrder` integer — Home page pin order (zero means not pinned)
      - `validBirthDate` boolean — BirthYearInLHijri, for some poets it is only indicator of their century of birth and should not be relied as their valid birth date
      - `validDeathDate` boolean — DeathYearInLHijri, for some poets it is only indicator of their century of death and should not be relied as their valid death date
      - `birthLocationId` integer, nullable — birth location id
      - `birthLocation` GanjoorGeoLocation — Geo Locations (Cities) referred by Ganjoor Metadata
        - `id` integer — id
        - `name` string, nullable — name
        - `latitude` number, double — Latitude
        - `longitude` number, double — Longitude
        - `machineGenerated` boolean — AI generated
      - `deathLocationId` integer, nullable — death location id
      - `deathLocation` GanjoorGeoLocation — Geo Locations (Cities) referred by Ganjoor Metadata
        - `id` integer — id
        - `name` string, nullable — name
        - `latitude` number, double — Latitude
        - `longitude` number, double — Longitude
        - `machineGenerated` boolean — AI generated
    - `title` string, nullable — text
    - `parentId` integer, nullable — parent_id
    - `parent` GanjoorCat — recursive
    - `urlSlug` string, nullable — url => slug
    - `fullUrl` string, nullable — sample: /hafez/ghazal
    - `tableOfContentsStyle` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — ganjoor TOC options
    - `catType` 0 | 1 | 2 — Ganjoor Category Type
    - `description` string, nullable — additional description or note
    - `descriptionHtml` string, nullable — html mode of additional description or note
    - `mixedModeOrder` integer — order when mixed with poems
    - `published` boolean — published
    - `bookName` string, nullable — category book name
    - `rImage` RImage — Image Files
      - `id` string, uuid — Id
      - `originalFileName` string, nullable — Original File Name
      - `contentType` string, nullable — content type
      - `fileSizeInBytes` integer — Original Image File Size In Byte
      - `imageWidth` integer — Original Image Width
      - `imageHeight` integer — Original Image Height
      - `folderName` string, nullable — پوشه محل ذخیره تصویر
      - `storedFileName` string, nullable — نام فایل ذخیره شده با بالاترین کیفیت
      - `dataTime` string, date-time — datetime
      - `lastModified` string, date-time — Last Modified for caching purposes
    - `rImageId` string, uuid, nullable — user image id
    - `sumUpSubsGeoLocations` boolean — sum up sub categories geo locations
    - `mapName` string, nullable — category map name
  - `endCatId` integer, nullable — ending category id
  - `endCat` GanjoorCat — Ganjoor Category
    - `id` integer — id
    - `poetId` integer — poet_id
    - `poet` GanjoorPoet — Ganjoor Poet
      - `id` integer — id
      - `name` string, nullable — name
      - `description` string, nullable — description
      - `nickname` string, nullable — short name
      - `rImage` RImage — Image Files
        - `id` string, uuid — Id
        - `originalFileName` string, nullable — Original File Name
        - `contentType` string, nullable — content type
        - `fileSizeInBytes` integer — Original Image File Size In Byte
        - `imageWidth` integer — Original Image Width
        - `imageHeight` integer — Original Image Height
        - `folderName` string, nullable — پوشه محل ذخیره تصویر
        - `storedFileName` string, nullable — نام فایل ذخیره شده با بالاترین کیفیت
        - `dataTime` string, date-time — datetime
        - `lastModified` string, date-time — Last Modified for caching purposes
      - `rImageId` string, uuid, nullable — user image id
      - `published` boolean — published on website
      - `birthYearInLHijri` integer — birth year in lunar hijri
      - `deathYearInLHijri` integer — death year in lunar hijri
      - `pinOrder` integer — Home page pin order (zero means not pinned)
      - `validBirthDate` boolean — BirthYearInLHijri, for some poets it is only indicator of their century of birth and should not be relied as their valid birth date
      - `validDeathDate` boolean — DeathYearInLHijri, for some poets it is only indicator of their century of death and should not be relied as their valid death date
      - `birthLocationId` integer, nullable — birth location id
      - `birthLocation` GanjoorGeoLocation — Geo Locations (Cities) referred by Ganjoor Metadata
        - `id` integer — id
        - `name` string, nullable — name
        - `latitude` number, double — Latitude
        - `longitude` number, double — Longitude
        - `machineGenerated` boolean — AI generated
      - `deathLocationId` integer, nullable — death location id
      - `deathLocation` GanjoorGeoLocation — Geo Locations (Cities) referred by Ganjoor Metadata
        - `id` integer — id
        - `name` string, nullable — name
        - `latitude` number, double — Latitude
        - `longitude` number, double — Longitude
        - `machineGenerated` boolean — AI generated
    - `title` string, nullable — text
    - `parentId` integer, nullable — parent_id
    - `parent` GanjoorCat — recursive
    - `urlSlug` string, nullable — url => slug
    - `fullUrl` string, nullable — sample: /hafez/ghazal
    - `tableOfContentsStyle` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — ganjoor TOC options
    - `catType` 0 | 1 | 2 — Ganjoor Category Type
    - `description` string, nullable — additional description or note
    - `descriptionHtml` string, nullable — html mode of additional description or note
    - `mixedModeOrder` integer — order when mixed with poems
    - `published` boolean — published
    - `bookName` string, nullable — category book name
    - `rImage` RImage — Image Files
      - `id` string, uuid — Id
      - `originalFileName` string, nullable — Original File Name
      - `contentType` string, nullable — content type
      - `fileSizeInBytes` integer — Original Image File Size In Byte
      - `imageWidth` integer — Original Image Width
      - `imageHeight` integer — Original Image Height
      - `folderName` string, nullable — پوشه محل ذخیره تصویر
      - `storedFileName` string, nullable — نام فایل ذخیره شده با بالاترین کیفیت
      - `dataTime` string, date-time — datetime
      - `lastModified` string, date-time — Last Modified for caching purposes
    - `rImageId` string, uuid, nullable — user image id
    - `sumUpSubsGeoLocations` boolean — sum up sub categories geo locations
    - `mapName` string, nullable — category map name
  - `totalLines` integer — lines count
  - `totalVerses` integer — verse count
  - `totalCouplets` integer — total poem couplets
  - `totalParagraphs` integer — total paragraphs
  - `lastCountingDate` string, date-time — last counting date

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/ganjoor/apis/rmuseum-api.md) · [All operations](https://skmtc.net/ganjoor/apis/rmuseum-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ganjoor/rmuseum-api/versions/bb8e104d36d2/schema)
