Qodex.ai

Get NANPA Prefixes

GET https://{{host}}/v3/nanpa_prefixes

Returns a collection of NANPA Prefixes.

Request Params

KeyDatatypeRequiredDescription
includenullComma-separated values of include parameter.
The response will include a top-level object relationships with associated data under the appropriate resource key.
Details in Inclusion of Related Resources Article.

Allowed values:

country - Country Object

region - Region Object *** | | filter[id] | null | | string - Filters by NANPA Prefixes id field.

  • Allow blank - No.
  • Allow array - Yes. | | filter[npa] | null | | string - Filters by NANPA Prefixes npa field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[nxx] | null | | string - Filters by NANPA Prefixes nxx field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[npanxx] | null | | string - Filters by NANPA Prefixes npa / nxx fields.
  • Allow blank - No.
  • Allow array - No. | | filter[country.id] | null | | string - Filters by NANPA Prefixes country.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[region.id] | null | | string - Filters by NANPA Prefixes region.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[did_group.is_available] | null | | boolean - Availability of DIDs in stock for prefix.
  • Allow blank - No.
  • Allow array - No. | | filter[did_group.features] | null | | string - Availability of DIDs in stock with features for prefix. Can be one/several/all of “voice_in”, “voice_out”, “t38”, “sms_in”, “sms_out”. example: “voice_in,sms_in”.
  • Allow blank - No.
  • Allow array - Yes. | | sort | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

npa - The npa field.

nxx - The nxx field. *** |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"data":[{"id":"1d968dcf-8ee7-40fa-8073-cdbc027bc3b3","type":"nanpa_prefixes","attributes":{"npa":"201","nxx":"221"},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/1d968dcf-8ee7-40fa-8073-cdbc027bc3b3/relationships/country","related":"https://api.didww.com/v3/nanpa_prefixes/1d968dcf-8ee7-40fa-8073-cdbc027bc3b3/country"},"data":{"type":"countries","id":"1f6fc2bd-f081-4202-9b1a-d9cb88d942b9"}},"region":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/1d968dcf-8ee7-40fa-8073-cdbc027bc3b3/relationships/region","related":"https://api.didww.com/v3/nanpa_prefixes/1d968dcf-8ee7-40fa-8073-cdbc027bc3b3/region"}}}},{"id":"c8770990-8a6f-4e11-8b88-420cc9375931","type":"nanpa_prefixes","attributes":{"npa":"201","nxx":"234"},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/c8770990-8a6f-4e11-8b88-420cc9375931/relationships/country","related":"https://api.didww.com/v3/nanpa_prefixes/c8770990-8a6f-4e11-8b88-420cc9375931/country"},"data":{"type":"countries","id":"1f6fc2bd-f081-4202-9b1a-d9cb88d942b9"}},"region":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/c8770990-8a6f-4e11-8b88-420cc9375931/relationships/region","related":"https://api.didww.com/v3/nanpa_prefixes/c8770990-8a6f-4e11-8b88-420cc9375931/region"}}}},{"id":"a5958064-96d7-4594-b9bc-a5b9c3bba01f","type":"nanpa_prefixes","attributes":{"npa":"201","nxx":"275"},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/a5958064-96d7-4594-b9bc-a5b9c3bba01f/relationships/country","related":"https://api.didww.com/v3/nanpa_prefixes/a5958064-96d7-4594-b9bc-a5b9c3bba01f/country"},"data":{"type":"countries","id":"1f6fc2bd-f081-4202-9b1a-d9cb88d942b9"}},"region":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/a5958064-96d7-4594-b9bc-a5b9c3bba01f/relationships/region","related":"https://api.didww.com/v3/nanpa_prefixes/a5958064-96d7-4594-b9bc-a5b9c3bba01f/region"}}}},{"id":"fcd178f8-3085-42c2-9831-7ca30fc01789","type":"nanpa_prefixes","attributes":{"npa":"201","nxx":"301"},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/fcd178f8-3085-42c2-9831-7ca30fc01789/relationships/country","related":"https://api.didww.com/v3/nanpa_prefixes/fcd178f8-3085-42c2-9831-7ca30fc01789/country"},"data":{"type":"countries","id":"1f6fc2bd-f081-4202-9b1a-d9cb88d942b9"}},"region":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/fcd178f8-3085-42c2-9831-7ca30fc01789/relationships/region","related":"https://api.didww.com/v3/nanpa_prefixes/fcd178f8-3085-42c2-9831-7ca30fc01789/region"}}}},{"id":"1ff532b2-fec0-4f13-b661-d688ac29dfb0","type":"nanpa_prefixes","attributes":{"npa":"201","nxx":"345"},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/1ff532b2-fec0-4f13-b661-d688ac29dfb0/relationships/country","related":"https://api.didww.com/v3/nanpa_prefixes/1ff532b2-fec0-4f13-b661-d688ac29dfb0/country"},"data":{"type":"countries","id":"1f6fc2bd-f081-4202-9b1a-d9cb88d942b9"}},"region":{"links":{"self":"https://api.didww.com/v3/nanpa_prefixes/1ff532b2-fec0-4f13-b661-d688ac29dfb0/relationships/region","related":"https://api.didww.com/v3/nanpa_prefixes/1ff532b2-fec0-4f13-b661-d688ac29dfb0/region"}}}}],"included":[{"id":"1f6fc2bd-f081-4202-9b1a-d9cb88d942b9","type":"countries","attributes":{"name":"United States","prefix":"1","iso":"US"},"relationships":{"regions":{"links":{"self":"https://api.didww.com/v3/countries/1f6fc2bd-f081-4202-9b1a-d9cb88d942b9/relationships/regions","related":"https://api.didww.com/v3/countries/1f6fc2bd-f081-4202-9b1a-d9cb88d942b9/regions"}}}}],"meta":{"total_records":4330,"api_version":"2022-05-10"},"links":{"first":"https://api.didww.com/v3/nanpa_prefixes?include=country\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=5","next":"https://api.didww.com/v3/nanpa_prefixes?include=country\u0026page%5Bnumber%5D=2\u0026page%5Bsize%5D=5","last":"https://api.didww.com/v3/nanpa_prefixes?include=country\u0026page%5Bnumber%5D=866\u0026page%5Bsize%5D=5"}}