Skip to content
Docs
API reference / Districts

Get Districts

MD View as MarkdownPlain text version of this page
Open in ClaudeAsk questions about this page Open in ChatGPTAsk questions about this page
GET /api/v1/districts

Token needs the read ability. About tokens

Retrieves a paginated list of District objects. Requires the read ability.

Query parameters

  • page[number] integer
    Page number (starts at 1).
  • page[size] integer
    Results per page (default 30, max 100).
  • filter[external_id] string
  • filter[district_group_id] string (uuid)
  • sort string
    Allowed: name, created_at, updated_at. Default: name.
  • include string
    Allowed: districtGroup.

Responses

    • links object
      • first string nullable
      • last string nullable
      • prev string nullable
      • next string nullable
    • meta object
      • current_page integer
      • from integer nullable
      • last_page integer
      • path string
      • per_page integer
      • to integer nullable
      • total integer
    • data array of District
      • id string (uuid)
      • name string
      • external_id string nullable
      • district_group_id string (uuid) nullable
      • created_at string (date-time) nullable
      • updated_at string (date-time) nullable
      • districtGroup object nullable
        Present only when included.
        • id string (uuid)
        • name string
        • index integer
        • created_at string (date-time) nullable
        • updated_at string (date-time) nullable
    • message string
    • message string 
curl "https://app.franchisesee.com/api/v1/districts" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json"
Response 
{
    "links": {
        "first": "https://app.franchisesee.com/api/v1/locations?page[number]=1",
        "last": "https://app.franchisesee.com/api/v1/locations?page[number]=10",
        "prev": "https://app.franchisesee.com/api/v1/locations?page[number]=1",
        "next": "https://app.franchisesee.com/api/v1/locations?page[number]=3"
    },
    "meta": {
        "current_page": 2,
        "from": 26,
        "last_page": 10,
        "path": "https://app.franchisesee.com/api/v1/locations",
        "per_page": 25,
        "to": 50,
        "total": 250
    },
    "data": [
        {
            "id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
            "name": "Central Texas",
            "external_id": "CTX",
            "district_group_id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
            "created_at": "2025-03-14T15:22:08.000000Z",
            "updated_at": "2026-10-02T09:41:55.000000Z",
            "districtGroup": {
                "id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                "name": "Region",
                "index": 1,
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z"
            }
        }
    ]
}