List Phone Numbers

Authorizations

Authorization

string

headerrequired

Retrieve your key from Dashboard.

Query Parameters

limit

number

This is the maximum number of items to return. Defaults to 100.

Required range: 0 < x < 1000

createdAtGt

string

This will return items where the createdAt is greater than the specified value.

createdAtLt

string

This will return items where the createdAt is less than the specified value.

createdAtGe

string

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLe

string

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGt

string

This will return items where the updatedAt is greater than the specified value.

updatedAtLt

string

This will return items where the updatedAt is less than the specified value.

updatedAtGe

string

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLe

string

This will return items where the updatedAt is less than or equal to the specified value.

Response

200 - application/json

id

string

required

This is the unique identifier for the phone number.

orgId

string

required

This is the unique identifier for the org that this phone number belongs to.

createdAt

string

required

This is the ISO 8601 date-time string of when the phone number was created.

updatedAt

string

required

This is the ISO 8601 date-time string of when the phone number was last updated.

stripeSubscriptionId

string

This is the subscription for the phone number.

stripeSubscriptionStatus

string

This is the subscription's status.

stripeSubscriptionCurrentPeriodStart

string

This is the subscription's current period start.

number

string

required

These are the digits of the phone number.

twilioAccountSid

string

This is the Twilio Account SID for the phone number.

This is for numbers not bought on Vapi.

twilioAuthToken

string

This is the Twilio Auth Token for the phone number.

This is for numbers not bought on Vapi.

credentialId

string

This is the credential that will be used to handle this phone number.

This is for numbers not bought on Vapi.

name

string

This is the name of the phone number. This is just for your own reference.

Maximum length: 40

assistantId

string | null

This is the assistant that will be used for incoming calls to this phone number.

If this is not set, then the phone number will not handle incoming calls.

serverUrl

string

This is the server URL that will be used to handle this phone number.

All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.

This overrides the serverUrl set on the org. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.

serverUrlSecret

string

This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.

Same precendence logic as serverUrl.