---
title: "List all existing areas with filtering capabilities"
method: GET
path: "/management/v2/areas"
tags: ["Area Profile"]
---

# List all existing areas with filtering capabilities

`GET /management/v2/areas`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/management/v2/areas`
- Auth: API key in header `OAuth`

Supports searching by name, location ID, active status, and other fields using the filters parameter.

## Query parameters

- `filters` string[]
- `op` string
- `cursor` string
- `limit` integer
- `excludeSoft` integer
- `shiftIds` integer[]

## Response `200`

A successful response.

- AreaProfileListResponse
  - `success` boolean
  - `data` V2modelAreaProfile[]
    - `id` integer
    - `name` string
    - `locationId` integer
    - `parentId` integer
    - `workType` string
    - `isActive` boolean
    - `exportCode` string
    - `addressId` integer
    - `contactId` integer
    - `rosterSortOrder` integer
    - `isOnRoster` boolean
    - `color` string
    - `areaType` 'DEFAULT_AREA' | 'AREA_WITH_GEO'
    - `createdById` integer
    - `createdAt` string, date-time
    - `modifiedAt` string, date-time
    - `address` Tenantlocationv2modelAddress
      - `id` integer
      - `street` string
      - `state` string
      - `postcode` string
      - `country` string
      - `verifiedAt` string, date-time
      - `note` string
      - `print` string
    - `geo` ModelAreaProfileLocationGeo
      - `latitude` number, double
      - `longitude` number, double
  - `nextCursor` string: Cursor to fetch the next page of results. Base64 encoded value. Present only if more results are available. Empty string if this is the last page.

---

[API](https://skmtc.dev/deputy/apis/deputy-v2-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v2-api/revisions/78f0278f4608?raw)