Essentials
Calls
Contact Custom Fields
Contacts
Conversations
Phone Numbers
List phone numbers
Retrieve the list of phone numbers and users associated with your OpenPhone workspace.
curl --request GET \
--url https://api.openphone.com/v1/phone-numbers{
"data": [
{
"id": "PN123bc",
"groupId": "1234",
"createdAt": " '2022-01-01T00:00:00Z'",
"updatedAt": " '2022-01-01T00:00:00Z'",
"name": "My phone number",
"number": "+15555555555",
"formattedNumber": "+15555555555",
"forward": "+15555555555",
"portRequestId": "123abc",
"portingStatus": "completed",
"symbol": "🏡",
"users": [
{
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"groupId": "GRcei8k90o",
"id": "USCuU7xyz7",
"role": "owner"
}
],
"restrictions": {
"messaging": {
"CA": "unrestricted",
"US": "restricted",
"Intl": "unrestricted"
},
"calling": {
"CA": "unrestricted",
"US": "unrestricted",
"Intl": "unrestricted"
}
}
}
]
}Query Parameters
Filter results to return only phone numbers associated with the specified user"s unique identifier.
Response
The unique identifier of OpenPhone phone number.
The unique identifier of the group to which the OpenPhone number belongs.
Timestamp of when the phone number was added to the account in ISO 8601 format.
Timestamp of the last update to the phone number's details in ISO 8601 format.
The display name of the phone number
A phone number in E.164 format, including the country code.
A human-readable representation of a phone number.
Forwarding number for incoming calls, null if no forwarding number is configured.
Unique identifier for the phone number’s porting request, if applicable.
Current status of the porting process, if applicable.
Custom symbol or emoji associated with the phone number.
Phone number usage restrictions for messaging and calling by region. Use these properties to know if a particular phone number is allowed to message or call a number in a region.
Region-specific restrictions, including United States, Canada, and International (outside of US or CA).
The phone-number usage restriction status for a specific region
restricted, unrestricted The phone-number usage restriction status for a specific region
restricted, unrestricted The phone-number usage restriction status for a specific region
restricted, unrestricted Region-specific restrictions, including United States, Canada, and International (outside of US or CA).
The phone-number usage restriction status for a specific region
restricted, unrestricted The phone-number usage restriction status for a specific region
restricted, unrestricted The phone-number usage restriction status for a specific region
restricted, unrestricted Was this page helpful?
curl --request GET \
--url https://api.openphone.com/v1/phone-numbers{
"data": [
{
"id": "PN123bc",
"groupId": "1234",
"createdAt": " '2022-01-01T00:00:00Z'",
"updatedAt": " '2022-01-01T00:00:00Z'",
"name": "My phone number",
"number": "+15555555555",
"formattedNumber": "+15555555555",
"forward": "+15555555555",
"portRequestId": "123abc",
"portingStatus": "completed",
"symbol": "🏡",
"users": [
{
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"groupId": "GRcei8k90o",
"id": "USCuU7xyz7",
"role": "owner"
}
],
"restrictions": {
"messaging": {
"CA": "unrestricted",
"US": "restricted",
"Intl": "unrestricted"
},
"calling": {
"CA": "unrestricted",
"US": "unrestricted",
"Intl": "unrestricted"
}
}
}
]
}