GET
/
phone-numbers
curl --request GET \
  --url https://api.puretalk.ai/api/phone-numbers \
  --header 'X-API-KEY: <api-key>'
{
  "count": 10,
  "next": "https://api.puretalk.ai/api/phone-numbers?page=2",
  "previous": "https://api.puretalk.ai/api/phone-numbers?page=1",
  "results": [
    {
      "user": {
        "name": "John Doe",
        "dp": "https://api.puretalk.ai/api/users/1/profile_picture.jpg",
        "email": "[email protected]"
      },
      "ai_assistant": {
        "assistant_id": "00ef5401-cbfb-450a-a806-adad5dd907f3",
        "name": "My AI Assistant",
        "variables": [
          "<string>"
        ]
      },
      "additional_data": {
        "postal_code": "<string>",
        "capabilities": {
          "voice": true,
          "SMS": true,
          "MMS": true
        },
        "locality": "<string>",
        "region": "<string>",
        "iso_country": "<string>"
      },
      "phone_number_id": "<string>",
      "phone_number": "<string>",
      "friendly_name": "<string>",
      "provider": "<string>",
      "provider_id": "<string>",
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Authorization header containing API key. You can find your API key in the dashboard under 'API Keys'.

Query Parameters

​
page
integer

The page number to return

​
limit
integer

The maximum number of results to return

Response

200
application/json

Phone numbers response

The response is of type object.