Numbers & Inventory

List purchased numbers

Retrieve a list of DID numbers purchased by the authenticated user.

Important notes:

  • Returns only active numbers by default
  • Use show_all=true to include numbers pending document approval
  • Includes service information (SMS, etc.)
  • Shows current status of each number

When to use:

  • Displaying user's number inventory
  • Checking number status
  • Listing numbers for configuration
  • Dashboard display

dids[].id feeds numbers_purchase_update and numbers_purchase_destroy (id, id_in[]). dids[].number feeds numbers_purchase_destroy (did_numbers[]). dids[].id feeds purchases_destinations_index, purchases_destinations_create, purchases_destinations_update and purchases_destinations_destroy (purchase_id, which takes the number too). dids[].identity_id feeds identities_index and numbers_purchase_update (ids, identity_id). See also: purchases_index.

get/api/v2/numbers

Request

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

Query parameters

show_allstring

Include numbers pending documentation approval

Response

returns DIDs

Example response

{
  "dids": [
    {
      "id": 325,
      "number": "1234567890",
      "country": "United States",
      "area": "New York",
      "channels": 1,
      "activation": 1.17,
      "monthly_fee": 1.17,
      "per_minute": 0.117,
      "status": "active",
      "commitment_months": 6,
      "identity_id": 194
    }
  ]
}

Changes

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