REregdoor
sectors

List Sectors

List sectors with optional filters.

Args: father_sector_uuid: Optional filter to list only subsectors of a specific sector. If not provided, lists all sectors (root sectors and subsectors). include_deleted: Whether to include soft-deleted sectors in the results. only_names: Whether to return uuid, name, and father_sector_uuid (without relationships).

Returns: Paginated list of Sector instances

get/api/sectors/

Request

  • Base URL
    https://api.regdoor.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

father_sector_uuidstring uuid nullable

Filter by father sector UUID (list subsectors of a specific sector)

include_deletedboolean

Include soft-deleted sectors in the results

only_namesboolean

When true, returns uuid, name, and father_sector_uuid for each sector (without relationships)

pageinteger

Page number

sizeinteger

Page size

Response

Successful Response

totalinteger nullable required
pageinteger nullable required
sizeinteger nullable required
pagesinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.