> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.bitbybit.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# List sub-districts

> Return KiriminAja sub-districts (`kelurahan`) for a given district. Sub-district IDs are needed for `senderKelurahanId` / `deliveryKelurahanId` when booking a KiriminAja Express shipment.



## OpenAPI

````yaml GET /shipping/coverage/sub-districts
openapi: 3.1.0
info:
  title: bitbybit Open API — Shipping
  description: >-
    Programmatic access to bitbybit shipping: store locations, provider
    discovery, coverage lookup, fee quoting, and the full shipment lifecycle
    (create, book, update, cancel, track) across GoSend, KiriminAja, and
    RideBlitz.
  version: 1.0.0
  contact:
    name: bitbybit Support
    url: https://bitbybit.studio
servers:
  - url: https://api.bitbybit.studio/customer/api/open/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Store Locations
    description: >-
      Manage warehouse / pickup origin addresses. Couriers pick up from these
      locations when a shipment is booked.
  - name: Providers
    description: Discover connected carriers and the services each carrier offers.
  - name: Coverage
    description: >-
      Look up the courier-specific province / city / district / sub-district
      dictionaries needed to populate addresses and quote fees.
  - name: Fee Calculation
    description: Quote shipping fees across carriers using one unified request shape.
  - name: Shipments
    description: >-
      Create, update, cancel, and track shipments. A shipment is always attached
      to an Order.
paths:
  /shipping/coverage/sub-districts:
    get:
      tags:
        - Coverage
      summary: List sub-districts (KiriminAja)
      description: >-
        Return KiriminAja sub-districts (`kelurahan`) for a given district.
        Sub-district IDs are needed for `senderKelurahanId` /
        `deliveryKelurahanId` when booking a KiriminAja Express shipment.
      operationId: getCoverageSubDistricts
      parameters:
        - name: provider
          in: query
          schema:
            type: string
            enum:
              - kirimin_aja
            default: kirimin_aja
        - name: districtId
          in: query
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Sub-districts list.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        subDistrictId:
                          type: integer
                        subDistrictName:
                          type: string
                        districtId:
                          type: integer
        '400':
          $ref: '#/components/responses/IntegrationNotConnected'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    IntegrationNotConnected:
      description: The required courier integration is not connected for this company.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTEGRATION_NOT_CONNECTED
              message: >-
                KiriminAja is not connected. Connect KiriminAja in Settings >
                Integrations first.
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Invalid API key
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine-readable code, e.g. `VALIDATION_ERROR`, `NOT_FOUND`,
                `INTEGRATION_NOT_CONNECTED`, `PROVIDER_ERROR`, `BOOKING_FAILED`.
            message:
              type: string
              description: Human-readable error message.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Create one in Settings > Developer. The key
        must have the `BITCRM` product scope and an `orders` resource scope;
        required action depends on the endpoint (`READ`, `WRITE`, or `DELETE`).

````