Numbers & Inventory

Search numbers (advanced)

Advanced search for available DID numbers with multiple filter criteria.

Important notes:

  • Supports pagination (page, per_page parameters)
  • All filter parameters are optional
  • Combine multiple filters for precise results
  • Use for complex search scenarios beyond location-based browsing

When to use:

  • Implementing vanity number search
  • Finding numbers with specific features
  • Custom number selection interfaces
  • Bulk number lookup

dids.dids[].id feeds numbers_purchase_create (id_in). dids.dids[].number feeds numbers_purchase_create (did_numbers). See also: numbers_countries_cities_dids_index.

get/api/v2/numbers/search

Request

  • Base URL: https://app.didlogic.com
  • URL: https://app.didlogic.com/api/v2/numbers/search
  • Auth: HTTP bearer

Query parameters

id_ininteger

Search for specific DID IDs (comma-separated)

number_instring

Search for specific numbers (exact match, comma-separated)

number_containsinteger

Search for numbers containing this pattern

begins_withinteger

Search for numbers beginning with this pattern

ends_withinteger

Search for numbers ending with this pattern

city_name_containsstring

Filter by city name (partial match)

country_name_containsstring

Filter by country name (partial match), from numbers_countries_index

state_name_containsstring

Filter by state/region name (partial match, US only), from numbers_countries_regions_index

sms_enabledstring

Filter by SMS capability (true/false)

no_local_clistring

Filter by local caller ID capability (true/false)

vendor_idinteger

Filter by vendor ID (requires special permission)

city_idinteger

City id from numbers_countries_cities_index, numbers_countries_locations_index

region_idinteger

Region id from numbers_countries_regions_index, numbers_countries_locations_index

require_docsinteger

Filter by document requirements

commitment_monthsinteger

Filter by commitment period in months

cheap_sortingstring

Sort by price (activation + monthly fee) ascending

pageinteger

Page number for pagination

per_pageinteger

Number of items per page

Response

returns search results

Example response

{
  "dids": {
    "pagination": {
      "total": 1,
      "total_pages": 1,
      "current_page": 1
    },
    "dids": [
      {
        "id": 322,
        "country": "United States",
        "city": "NEW YORK CITY",
        "sms_enabled": true,
        "channels": 2,
        "free_min": 100,
        "commitment_months": 12,
        "required_documents": [
          {
            "type": 7,
            "name": "Proof of Address"
          }
        ],
        "activation": 2.925,
        "monthly": 0.9945,
        "per_minute": 0.117,
        "country_short_name": "US",
        "number": "12125551234",
        "never_sold": 1
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.