Skip to content

Method: projects.phoneNumberInstances.list

Lists all phone number instances.

List returns phone number instances sorted by create_time descending.

The caller must have numbering.phoneNumberInstances.list permission on the project.

HTTP request

GET https://numbering.api.enfonica.com/v1beta1/{parent}/phoneNumberInstances

Path parameters

Parameters  
parent string
The project under which to list phone number instance, in the form projects/*.

Query parameters

Parameters  
pageSize number (int32 format)
The maximum number of phone number instance to return in the response. Default value of 10 and maximum value of 100.
pageToken string
A pagination token returned from a previous call to ListPhoneNumberInstances that indicates where this listing should continue from.
prefix string
The prefix, either in E164 or 0NSN, of numbers to retrieve.
includeDeleted boolean
Whether to include deleted phone numbers in the response. Defaults to false.

Request body

The request body must be empty.

Response body

The ListPhoneNumberInstances response.

JSON representation
{
  "phoneNumberInstances": [
    {
      object (PhoneNumberInstance)
    }
  ],
  "nextPageToken": string
}
Fields  
phoneNumberInstances[] object (PhoneNumberInstance)
A possibly paginated list of phone number instance that are direct descendants of the specified parent resource.
nextPageToken string
A pagination token returned from a previous call to ListPhoneNumberInstances that indicates from where listing should continue.