Get NANPA Prefixes#

Returns a collection of NANPA Prefixes.

Request#

HTTP Method: GET

URI Path: /v3/nanpa_prefixes

Note

For all returned data attributes, see Nanpa Prefixes Object.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string, boolean

No

Filtering

fields[nanpa_prefixes]

string

No

Sparse fieldsets

sort

string

No

Sorting

Includes#

Value

Description

country

Country Object

region

Region Object

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

NANPA Prefixes id field.

npa

string

Yes

Yes

NANPA Prefixes npa field.

nxx

string

Yes

Yes

NANPA Prefixes nxx field.

npanxx

string

No

No

NANPA Prefixes npa / nxx fields.

country.id

string

Yes

Yes

A country.id field.

region.id

string

Yes

Yes

A region.id field.

did_group.is_available

boolean

No

No

Availability of DIDs in stock for prefix.

did_group.features

string

No

Yes

Availability of DIDs in stock with features for prefix. Can be one/several/all of ‘voice_in’, ‘voice_out’, ‘t38’, ‘sms_in’, ‘sms_out’.

Sorting#

Value

Sorts by:

npa

NANPA Prefixes npa field.

nxx

NANPA Prefixes nxx field.

Examples#

http

1GET /v3/nanpa_prefixes HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API Token]

curl

1curl -i -X GET https://api.didww.com/v3/nanpa_prefixes -H "Accept: application/vnd.api+json" -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json"

response

  1HTTP/2 200 OK
  2Content-Type: application/vnd.api+json
  3
  4 {
  5     "data": [
  6         {
  7             "id": "1d968dcf-8ee7-40fa-8073-cdbc027bc3b3",
  8             "type": "nanpa_prefixes",
  9             "attributes": {
 10                 "npa": "201",
 11                 "nxx": "221"
 12             },
 13             "relationships": {
 14                 "country": {
 15                     "links": {
 16                         "self": "https://api.didww.com/v3/nanpa_prefixes/1d968dcf-8ee7-40fa-8073-cdbc027bc3b3/relationships/country",
 17                         "related": "https://api.didww.com/v3/nanpa_prefixes/1d968dcf-8ee7-40fa-8073-cdbc027bc3b3/country"
 18                     }
 19                 },
 20                 "region": {
 21                     "links": {
 22                         "self": "https://api.didww.com/v3/nanpa_prefixes/1d968dcf-8ee7-40fa-8073-cdbc027bc3b3/relationships/region",
 23                         "related": "https://api.didww.com/v3/nanpa_prefixes/1d968dcf-8ee7-40fa-8073-cdbc027bc3b3/region"
 24                     }
 25                 }
 26             }
 27         },
 28         {
 29             "id": "c8770990-8a6f-4e11-8b88-420cc9375931",
 30             "type": "nanpa_prefixes",
 31             "attributes": {
 32                 "npa": "201",
 33                 "nxx": "234"
 34             },
 35             "relationships": {
 36                 "country": {
 37                     "links": {
 38                         "self": "https://api.didww.com/v3/nanpa_prefixes/c8770990-8a6f-4e11-8b88-420cc9375931/relationships/country",
 39                         "related": "https://api.didww.com/v3/nanpa_prefixes/c8770990-8a6f-4e11-8b88-420cc9375931/country"
 40                     }
 41                 },
 42                 "region": {
 43                     "links": {
 44                         "self": "https://api.didww.com/v3/nanpa_prefixes/c8770990-8a6f-4e11-8b88-420cc9375931/relationships/region",
 45                         "related": "https://api.didww.com/v3/nanpa_prefixes/c8770990-8a6f-4e11-8b88-420cc9375931/region"
 46                     }
 47                 }
 48             }
 49         },
 50         {
 51             "id": "a5958064-96d7-4594-b9bc-a5b9c3bba01f",
 52             "type": "nanpa_prefixes",
 53             "attributes": {
 54                 "npa": "201",
 55                 "nxx": "275"
 56             },
 57             "relationships": {
 58                 "country": {
 59                     "links": {
 60                         "self": "https://api.didww.com/v3/nanpa_prefixes/a5958064-96d7-4594-b9bc-a5b9c3bba01f/relationships/country",
 61                         "related": "https://api.didww.com/v3/nanpa_prefixes/a5958064-96d7-4594-b9bc-a5b9c3bba01f/country"
 62                     }
 63                 },
 64                 "region": {
 65                     "links": {
 66                         "self": "https://api.didww.com/v3/nanpa_prefixes/a5958064-96d7-4594-b9bc-a5b9c3bba01f/relationships/region",
 67                         "related": "https://api.didww.com/v3/nanpa_prefixes/a5958064-96d7-4594-b9bc-a5b9c3bba01f/region"
 68                     }
 69                 }
 70             }
 71         },
 72         {
 73             "id": "fcd178f8-3085-42c2-9831-7ca30fc01789",
 74             "type": "nanpa_prefixes",
 75             "attributes": {
 76                 "npa": "201",
 77                 "nxx": "301"
 78             },
 79             "relationships": {
 80                 "country": {
 81                     "links": {
 82                         "self": "https://api.didww.com/v3/nanpa_prefixes/fcd178f8-3085-42c2-9831-7ca30fc01789/relationships/country",
 83                         "related": "https://api.didww.com/v3/nanpa_prefixes/fcd178f8-3085-42c2-9831-7ca30fc01789/country"
 84                     }
 85                 },
 86                 "region": {
 87                     "links": {
 88                         "self": "https://api.didww.com/v3/nanpa_prefixes/fcd178f8-3085-42c2-9831-7ca30fc01789/relationships/region",
 89                         "related": "https://api.didww.com/v3/nanpa_prefixes/fcd178f8-3085-42c2-9831-7ca30fc01789/region"
 90                     }
 91                 }
 92             }
 93         },
 94         {
 95             "id": "1ff532b2-fec0-4f13-b661-d688ac29dfb0",
 96             "type": "nanpa_prefixes",
 97             "attributes": {
 98                 "npa": "201",
 99                 "nxx": "345"
100             },
101             "relationships": {
102                 "country": {
103                     "links": {
104                         "self": "https://api.didww.com/v3/nanpa_prefixes/1ff532b2-fec0-4f13-b661-d688ac29dfb0/relationships/country",
105                         "related": "https://api.didww.com/v3/nanpa_prefixes/1ff532b2-fec0-4f13-b661-d688ac29dfb0/country"
106                     }
107                 },
108                 "region": {
109                     "links": {
110                         "self": "https://api.didww.com/v3/nanpa_prefixes/1ff532b2-fec0-4f13-b661-d688ac29dfb0/relationships/region",
111                         "related": "https://api.didww.com/v3/nanpa_prefixes/1ff532b2-fec0-4f13-b661-d688ac29dfb0/region"
112                     }
113                 }
114             }
115         }
116     ],
117     "meta": {
118         "total_records": 4330,
119         "api_version": "2026-04-16"
120     },
121     "links": {
122         "first": "https://api.didww.com/v3/nanpa_prefixes?page%5Bnumber%5D=1&page%5Bsize%5D=5",
123         "next": "https://api.didww.com/v3/nanpa_prefixes?page%5Bnumber%5D=2&page%5Bsize%5D=5",
124         "last": "https://api.didww.com/v3/nanpa_prefixes?page%5Bnumber%5D=866&page%5Bsize%5D=5"
125     }
126 }

Other Responses#

Code

Success

Description

401

No

Unauthorized