List All E911-Associated Phone Numbers

Returns a list of your Flowroute long code phone numbers associated with a specified E911 record.

Endpoint

GET /e911s/:e911_id/relationships/numbers

Path Parameter

  • e911_id
    integer REQUIRED

    The specific E911 record with the associated phone numbers to be returned.

Response Fields

On success, the HTTP status code in the response header is 200 OK and the response body contains an array of associated phone numbers in JSON format. On error, the header status code is an error code and the response body contains an array of error objects.

  • data
    array

    An array of related number objects individually composed of:

    • attributes
      object

      Object composed of attributes associated with a phone number related to an E911 record:

      • alias string Friendly name for the phone number.

      • value integer Value of the associated phone number which is the same as the number object id.

    • id
      integer

      Unique identifier of the phone number relationship with the E911 record.

    • links
      object

      Links object pointing to the phone number-E911 relationship. For example, https://api.flowroute.com/v2/numbers/682705.

    • type
      string

      This will always be number.

  • links
    object

    Links object pointing to your search and a link to the next page if any. For example, https://api.flowroute.com/v2/e911s/20155/numbers?limit=10&offset=0.

Example Request

GET /v2/e911s/20155/relationships/numbers HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Example Request

curl -X GET https://api.flowroute.com/v2/e911s/20155/relationships/numbers -u accessKey:secretKey

Example Responses

200 OK

{
  "data": [
    {
      "attributes": {
        "alias": null,
        "value": "12065014377"
      },
      "id": "682705",
      "links": {
        "self": "https://api.flowroute.com/v2/numbers/682705"
      },
      "type": "number"
    },
    {
      "attributes": {
        "alias": null,
        "value": "12062011682"
      },
      "id": "143979",
      "links": {
        "self": "https://api.flowroute.com/v2/numbers/143979"
      },
      "type": "number"
    }
  ],
  "links": {
    "self": "https://api.flowroute.com/v2/e911s/20155/numbers?limit=10&offset;=0"
  }
}

422 UNPROCESSABLE ENTITY

{
  "errors": [
    {
      "detail": {
        "limit": [
          "Not a valid integer."
        ]
      },
      "id": "4de849a7-6b27-49da-b053-144dc738b282",
      "status": 422
    }
  ]
}