---
title: "Create an inventory coverage request"
method: GET
path: "/inventory_coverage"
tags: ["Inventory Level"]
---

# Create an inventory coverage request

`GET /inventory_coverage`

Creates an inventory coverage request. If locality, npa or national_destination_code is used in groupBy, and no region or locality filters are used, the whole paginated set is returned.

## Query parameters

- `filter` object
  - `npa` integer — Filter by npa
  - `nxx` integer — Filter by nxx
  - `administrative_area` string — Filter by administrative area
  - `phone_number_type` 'local' | 'toll_free' | 'national' | 'mobile' | 'landline' | 'shared_cost' — Filter by phone number type
  - `country_code` 'AT' | 'AU' | 'BE' | 'BG' | 'CA' | 'CH' | 'CN' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'ES' | 'FI' | 'FR' | 'GB' | 'GR' | 'HU' | 'HR' | 'IE' | 'IT' | 'LT' | 'LU' | 'LV' | 'NL' | 'NZ' | 'MX' | 'NO' | 'PL' | 'PT' | 'RO' | 'SE' | 'SG' | 'SI' | 'SK' | 'US' — Filter by country. Defaults to US
  - `count` boolean — Include count in the result
  - `features` string[] — Filter if the phone number should be used for voice, fax, mms, sms, emergency. Returns features in the response when used.
  - `groupBy` 'locality' | 'npa' | 'national_destination_code' — Filter to group results

## Response `200`

Successful response with a list of inventory coverage levels

- object
  - `data` InventoryCoverage[]
    - `group` string
    - `group_type` string
    - `number_range` integer
    - `number_type` 'did' | 'toll-free'
    - `phone_number_type` 'local' | 'toll_free' | 'national' | 'landline' | 'shared_cost' | 'mobile'
    - `coverage_type` 'number' | 'block'
    - `record_type` string
    - `administrative_area` string
    - `count` integer
    - `advance_requirements` boolean — Indicates if the phone number requires advance requirements.
  - `meta` InventoryCoverageMetadata
    - `total_results` integer

## Other responses

- `400` — Bad request, the request was unacceptable, often due to missing a required parameter.
- `401` — Unauthorized
- `404` — The requested resource doesn't exist.
- `422` — Unprocessable entity. Check the 'detail' field in response for details.
- `500` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/versions/8f5f4e537994/schema)