# Get Location Categories

`GET /api/v1/location-categories`

Retrieves a paginated list of LocationCategory objects. Requires the `read` ability.

## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `page[number]` | integer | no | Page number (starts at 1). |
| `page[size]` | integer | no | Results per page (default 30, max 100). |
| `filter[external_id]` | string | no |  |
| `filter[location_category_group_id]` | string | no |  |
| `sort` | string | no | Allowed: name, sort_order, created_at, updated_at. Default: sort_order. |
| `include` | string | no | Allowed: locationCategoryGroup. |

## Example request

```bash
curl "https://app.franchisesee.com/api/v1/location-categories" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json"
```

## Responses

### 200 Success

```json
{
    "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": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
            "name": "Inline",
            "external_id": "INLINE",
            "location_category_group_id": "f2b6d8a1-4c3e-4e7b-a5d9-1c8e3f6b2a40",
            "sort_order": 1,
            "created_at": "2025-03-14T15:22:08.000000Z",
            "updated_at": "2026-10-02T09:41:55.000000Z",
            "locationCategoryGroup": {
                "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"
            }
        }
    ]
}
```

### 401 Authentication failed or missing.

```json
{
    "message": "Unauthenticated."
}
```

### 403 The token lacks the required ability or the caller is not permitted.

```json
{
    "message": "This API token does not have the 'create' ability."
}
```
