Get a phone number

Returns a single phone number configuration by ID.

GET /api/v2/phone-numbers/{config_id}

Get a phone number

cURL

curl --request GET \
  --url https://api.heymilo.ai/api/v2/phone-numbers/{config_id} \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": {
    "id": "<string>",
    "phone_number": "<string>",
    "active": true,
    "object": "phone_number",
    "country_code": "US",
    "date_provisioned": 1739612400
  },
  "meta": {}
}

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 | null

Authorization · string | null

X-Workspace-Id · string | null

Path Parameters

config_id · string · required

Response

200

application/json

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.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.