{
  "info": {
    "_postman_id": "apeiron-phone_numbers",
    "name": "Apeiron API - Phone Numbers",
    "description": "Number search, reservation, inventory, feature management (CNAM, SMS, E911), number info lookups (LRN, CNAM, TFN), DNC lists, and spam lookups.\n\nCollection Version: 1.0.0\nBase URL: https://api.apeiron.io/v2\nAuth: HTTP Basic (email + API token) or JWT Bearer token\nAPI Reference: https://api.apeiron.io/v2/",
    "version": "1.0.0",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "basic",
    "basic": [
      {
        "key": "username",
        "value": "{{username}}",
        "type": "string"
      },
      {
        "key": "password",
        "value": "{{api_token}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.apeiron.io",
      "type": "string"
    },
    {
      "key": "username",
      "value": "",
      "type": "string"
    },
    {
      "key": "api_token",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Inventory",
      "description": "Inventory endpoints",
      "item": [
        {
          "name": "List trunk groups",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/voice/trunk_groups",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "voice",
                "trunk_groups"
              ]
            },
            "description": "List all trunk groups and short detail."
          }
        },
        {
          "name": "List phone numbers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/inventory/numbers?number=&feature=&page_size=100",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "inventory",
                "numbers"
              ],
              "query": [
                {
                  "key": "number",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "feature",
                  "value": "",
                  "description": "Specify a feature to only return numbers which support that feature",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "Custom page size for pagination",
                  "disabled": true
                }
              ]
            },
            "description": "List all phone numbers on the account"
          }
        }
      ]
    },
    {
      "name": "Phone Number Features",
      "description": "Phone Number Features endpoints",
      "item": [
        {
          "name": "List phone number features",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/features/{phone_number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "features",
                "{phone_number}"
              ]
            },
            "description": "Returns number features associated with the number"
          }
        },
        {
          "name": "Set CNAM on a number",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/features/{phone_number}/cnam",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "features",
                "{phone_number}",
                "cnam"
              ]
            },
            "description": "Set CNAM on a number. Some numbers may not be supported by this endpoint. Please contact support to update CNAM on unsupported numbers.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "cnam_outbound",
                  "description": "",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Get port out PIN",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/features/{phone_number}/port_out_pin",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "features",
                "{phone_number}",
                "port_out_pin"
              ]
            },
            "description": "Get current port out PIN for a number"
          }
        },
        {
          "name": "Set port out PIN",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/features/{phone_number}/port_out_pin",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "features",
                "{phone_number}",
                "port_out_pin"
              ]
            },
            "description": "Set port out PIN on a number",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "port_out_pin",
                  "description": "",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Remove port out PIN",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/features/{phone_number}/port_out_pin",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "features",
                "{phone_number}",
                "port_out_pin"
              ]
            },
            "description": "Remove port out PIN for a number"
          }
        },
        {
          "name": "Activate feature on a number",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/features/{phone_number}/{feature}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "features",
                "{phone_number}",
                "{feature}"
              ]
            },
            "description": "Activates feature on a number"
          }
        },
        {
          "name": "Deactivate feature on a number",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/features/{phone_number}/{feature}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "features",
                "{phone_number}",
                "{feature}"
              ]
            },
            "description": "Deactivates feature on a number"
          }
        }
      ]
    },
    {
      "name": "Phone Number Info",
      "description": "Phone Number Info endpoints",
      "item": [
        {
          "name": "LNP prequalify",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/prequal/lnp",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "prequal",
                "lnp"
              ]
            },
            "description": "Prequalify number(s) for porting. Use the bulk LNP prequalification endpoints for large requests.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "numbers",
                  "description": "A comma separated string of numbers",
                  "type": "text",
                  "value": "1234567890, 2345678901"
                }
              ]
            }
          }
        },
        {
          "name": "List LNP prequalification requests",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/prequal/lnp_bulk",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "prequal",
                "lnp_bulk"
              ]
            },
            "description": "List LNP prequalification requests"
          }
        },
        {
          "name": "Bulk LNP prequalify",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/prequal/lnp_bulk",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "prequal",
                "lnp_bulk"
              ]
            },
            "description": "Prequalify many numbers for porting. Processing will occur in the background. Use the get LNP prequalification request details endpoint to check status.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "numbers",
                  "description": "A comma separated string of numbers",
                  "type": "text",
                  "value": "1234567890, 2345678901"
                }
              ]
            }
          }
        },
        {
          "name": "Get LNP prequalification request",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/prequal/lnp_bulk/{lnp_prequal_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "prequal",
                "lnp_bulk",
                "{lnp_prequal_id}"
              ]
            },
            "description": "Get LNP prequalification request details"
          }
        },
        {
          "name": "Get number information",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/info/{number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "info",
                "{number}"
              ]
            },
            "description": "Get information about a number"
          }
        },
        {
          "name": "Get number CNAM",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/cnam/{number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "cnam",
                "{number}"
              ]
            },
            "description": "Get a number's CNAM, if it exists.\n> **NOTE**: This API is charged per dip at a rate of $0.0035. No charge is rendered if the number does not have a CNAM."
          }
        },
        {
          "name": "Get number LRN info",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/lrn/{number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "lrn",
                "{number}"
              ]
            },
            "description": "Get a number's LRN info, if it exists.\n> **NOTE**: This API is charged per dip at a rate of $0.0006."
          }
        },
        {
          "name": "Get TFN info",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/tfn/info/{number}?ani=1234567890&lata=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "tfn",
                "info",
                "{number}"
              ],
              "query": [
                {
                  "key": "ani",
                  "value": "1234567890",
                  "description": "Automatic number identification; or calling number",
                  "disabled": false
                },
                {
                  "key": "lata",
                  "value": "",
                  "description": "",
                  "disabled": false
                }
              ]
            },
            "description": "Get info on a toll free number\n> **NOTE**: This API is charged per dip at a rate of $0.0004."
          }
        },
        {
          "name": "Check do not call registry",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/do_not_call/{phone_number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "do_not_call",
                "{phone_number}"
              ]
            },
            "description": "Returns true if a given phone number is on the federal do not call registry.\n> **NOTE**: This API is charged per dip at a rate of $0.0002."
          }
        },
        {
          "name": "List international city codes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/international/?country_code=123&number_type=National",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "international"
              ],
              "query": [
                {
                  "key": "country_code",
                  "value": "123",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "number_type",
                  "value": "National",
                  "description": "Possible values are \"National\", \"Geographic\", \"Mobile\", and \"Toll Free\".",
                  "disabled": true
                }
              ]
            },
            "description": "Returns a list of international city codes."
          }
        }
      ]
    },
    {
      "name": "Phone Number Reservations",
      "description": "Phone Number Reservations endpoints",
      "item": [
        {
          "name": "List Reservations",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/reservations",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "reservations"
              ]
            },
            "description": "Retrieve a list of current reservations."
          }
        },
        {
          "name": "Create a Reservation",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/reservations",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "reservations"
              ]
            },
            "description": "Create a reservation."
          }
        },
        {
          "name": "List Reserved Numbers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/reservations/{reservation_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "reservations",
                "{reservation_id}"
              ]
            },
            "description": "Return a List of Reserved Numbers"
          }
        },
        {
          "name": "Reserve Number",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/reservations/{reservation_id}/{number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "reservations",
                "{reservation_id}",
                "{number}"
              ]
            },
            "description": "Reserve a previously searched for number"
          }
        },
        {
          "name": "Unreserve Number",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/reservations/{reservation_id}/{number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "reservations",
                "{reservation_id}",
                "{number}"
              ]
            },
            "description": "Unreserve a number."
          }
        }
      ]
    },
    {
      "name": "Phone Number Search",
      "description": "Phone Number Search endpoints",
      "item": [
        {
          "name": "Search numbers by NPA",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/search/npa/{npa}?count=5",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "search",
                "npa",
                "{npa}"
              ],
              "query": [
                {
                  "key": "count",
                  "value": "5",
                  "description": "How many numbers to return",
                  "disabled": true
                }
              ]
            },
            "description": "Search numbers by NPA"
          }
        },
        {
          "name": "Search numbers by NPA/NXX",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/search/npanxx/{npa}/{nxx}?count=5",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "search",
                "npanxx",
                "{npa}",
                "{nxx}"
              ],
              "query": [
                {
                  "key": "count",
                  "value": "5",
                  "description": "How many numbers to return",
                  "disabled": true
                }
              ]
            },
            "description": "Search numbers by NPA/NXX"
          }
        },
        {
          "name": "Search numbers by LATA",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/search/lata/{lata}?count=5",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "search",
                "lata",
                "{lata}"
              ],
              "query": [
                {
                  "key": "count",
                  "value": "5",
                  "description": "How many numbers to return",
                  "disabled": true
                }
              ]
            },
            "description": "Search numbers by LATA"
          }
        },
        {
          "name": "Search numbers by state",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/search/state/{state}?count=5",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "search",
                "state",
                "{state}"
              ],
              "query": [
                {
                  "key": "count",
                  "value": "5",
                  "description": "How many numbers to return",
                  "disabled": true
                }
              ]
            },
            "description": "Search numbers by state"
          }
        },
        {
          "name": "Search numbers by rate center",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/search/ratecenter/{state}/{rate_center}?count=5",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "search",
                "ratecenter",
                "{state}",
                "{rate_center}"
              ],
              "query": [
                {
                  "key": "count",
                  "value": "5",
                  "description": "How many numbers to return",
                  "disabled": true
                }
              ]
            },
            "description": "Search numbers by rate center"
          }
        },
        {
          "name": "Search international numbers by country code",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/numbers/search/international/{country_code_a3}?did_type=national&area_code=800&count=5",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "numbers",
                "search",
                "international",
                "{country_code_a3}"
              ],
              "query": [
                {
                  "key": "did_type",
                  "value": "national",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "area_code",
                  "value": "800",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "count",
                  "value": "5",
                  "description": "How many numbers to return",
                  "disabled": true
                }
              ]
            },
            "description": "Search international numbers by country code, as defined by [ISO 3166-1 alpha-3 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).  Note that numbers returned from this endpoint could be randomly assigned and would not be known before they are ordered; in this case, an encoded string representing a number will be returned (ex. *72-34RG0104*).  These encoded strings may be reserved and ordered like other numbers."
          }
        }
      ]
    },
    {
      "name": "Spam",
      "description": "Spam endpoints",
      "item": [
        {
          "name": "Check if caller is a spammer",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/spam/{number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "spam",
                "{number}"
              ]
            },
            "description": "Check if caller is a spammer"
          }
        }
      ]
    }
  ]
}