Skip to main content
GET
/
api
/
v2
/
phone-numbers
/
{config_id}
Get a phone number
curl --request GET \
  --url https://api.heymilo.ai/api/v2/phone-numbers/{config_id} \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "id": "<string>",
    "phone_number": "<string>",
    "active": true,
    "object": "phone_number",
    "country_code": "US",
    "date_provisioned": 1739612400
  },
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.heymilo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-KEY
string
header
required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY
string
required

Path Parameters

config_id
string
required

Response

Successful Response

data
PhoneNumberResponse · object
required

A phone number provisioned for the workspace.

Phone numbers are used by voice and SMS agents to communicate with candidates. The id is referenced in posting configs as phone_number_id.

meta
Meta · object

Optional metadata. Shape varies by endpoint.