Skip to main content
GET
/
v1
/
organization
/
apps
/
{appId}
/
phone-numbers
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/organization/apps/{appId}/phone-numbers \
  --header 'Authorization: Bearer <token>'
{
  "phoneNumbers": [
    {
      "phoneNumberId": "ph_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
      "appId": "app_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
      "number": "<string>",
      "numberType": "local",
      "location": "San Francisco, CA",
      "features": [
        "SMS",
        "MMS",
        "Voice"
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "totalCount": 123
}

Authorizations

​
Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

​
appId
string
required

Unique identifier for a App. Format: app_[test_]{ksuid}

Pattern: ^app_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Query Parameters

​
limit
string

Maximum number of phone numbers to return

Example:

"20"

​
offset
string

Number of phone numbers to skip

Example:

"0"

Response

List of phone numbers

​
phoneNumbers
object[]
required
​
totalCount
number
required