Numbers

Get numbers

GEThttps://api.smsedge.com/v1/numbers/get/

Returns the numbers in a list, or specific numbers by ID, one page at a time.

Send at least one of list_id, ids or dynamic. The pagination object gives limit, offset and total. See Pagination and limits.

If some of the ids are not found, the response is still 200 and errors lists the missing IDs.

Query params

  • list_idintegeroptional

    Return the numbers in this list.

  • idsstringoptional

    Comma-separated number IDs.

  • dynamicstringoptional

    Dynamic key of a sent campaign message. Returns the number that received the message.

  • typestringoptional

    Return only numbers of this type. Free: no clicks or leads. Clicker: clicked a link. Previewer: opened a link preview. Lead: signed up.

    Values: Free, Clicker, Previewer, Lead

  • devicestringoptional

    Return only numbers that clicked from this device name.

  • citystringoptional

    Return only numbers that clicked from this city.

  • limitintegeroptional

    Numbers per page, 1 to 1000. A value out of this range becomes 1000.

    Default: 1000

  • offsetintegeroptional

    Number of records to skip.

    Default: 0

Responses

  • 200A page of numbers.
  • 400No filter was sent.
  • 404No numbers match the filters, or the type, device or city is not known.
curl -X GET "https://api.smsedge.com/v1/numbers/get/?list_id=347617&ids=63264825474%2C63264825475" \
  -H "X-API-KEY: YOUR_API_KEY"
[
  {
    "success": true,
    "data": [
      {
        "id": 63264825474,
        "number": "447700900123",
        "number_normalized": "447700900123",
        "list_id": 347617,
        "country_id": 225,
        "country_name": "United Kingdom",
        "created": "2026-04-20 08:41:52",
        "name": "Jane",
        "status": "good",
        "type": "Free",
        "device": null,
        "city": null
      },
      {
        "id": 63264825475,
        "number": "447700900456",
        "number_normalized": "447700900456",
        "list_id": 347617,
        "country_id": 225,
        "country_name": "United Kingdom",
        "created": "2026-04-20 08:41:52",
        "name": "John",
        "status": "bad",
        "type": "Clicker",
        "device": null,
        "city": null
      }
    ],
    "errors": [],
    "pagination": {
      "limit": 2,
      "offset": 0,
      "total": 19360
    },
    "response": {
      "code": 200,
      "description": "OK",
      "date": "2026-11-16 13:59:09"
    },
    "api": {
      "version": "v1",
      "module": "numbers",
      "function": "get"
    },
    "user": {
      "id": 12345
    }
  }
]

All requests need your API key in the X-API-KEY header. See Authentication.