Skip to main content

List purchased numbers

GET 
/api/v2/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.

Request​

Responses​

returns DIDs