SUsurgeapi
Phone numbers

List phone numbers

Changed on

List all phone numbers for an account with cursor-based pagination.

get/accounts/{account_id}/phone_numbers

Request

  • Base URL
    https://api.surge.app
  • URL
    https://api.surge.app/accounts/{account_id}/phone_numbers
  • Auth
    HTTP bearer

Path parameters

account_idstring required

The account ID to list phone numbers for.

Example:acct_01j9a43avnfqzbjfch6pygv1td

Query parameters

afterstring

Cursor for forward pagination. Use the next_cursor from a previous response.

beforestring

Cursor for backward pagination. Use the previous_cursor from a previous response.

Response

List of phone numbers

Example response

{
  "data": [
    {
      "campaign": null,
      "campaign_id": null,
      "id": "pn_01jsjwe4d9fx3tpymgtg958d9w",
      "metadata": {
        "location": "Downtown store"
      },
      "name": "(801) 555-1234",
      "number": "+18015551234",
      "type": "local"
    }
  ],
  "pagination": {
    "next_cursor": null,
    "previous_cursor": null
  }
}

Changes

  • 912b2a3101fcRevision changes
    • info

      added the required property // to the response with the status

  • 645782889002Revision changes
    • info

      response property data/items/campaign_id deprecated

    • info

      added the required property // to the response with the status