Skip to main content
GET
Get a phone number

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

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

Optional metadata. Shape varies by endpoint.