Skip to main content

List all phone number configurations

GET 
/porting_orders/phone_number_configurations

Returns a list of phone number configurations paginated.

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[porting_order_id] uuid

    Filter results by porting order id

    filter[porting_order_id][in][] uuid[]

    Filter results by a list of porting order ids

    filter[porting_order.status] string

    Possible values: [activation-in-progress, cancel-pending, cancelled, draft, exception, foc-date-confirmed, in-process, ported, submitted]

    Filter results by a specific porting order status

    filter[porting_order.status][in][] string[]

    Possible values: [activation-in-progress, cancel-pending, cancelled, draft, exception, foc-date-confirmed, in-process, ported, submitted]

    Filter results by a specific porting order status

    filter[has_user_bundle] boolean

    Filter results by whether or not the porting phone number is associated with a user bundle

    filter[porting_phone_number] uuid

    Filter results by a specific porting phone number ID

    filter[porting_phone_number][in][] uuid[]

    Filter results by a list of porting phone number IDs

    filter[user_bundle_id] uuid

    Filter results by a specific user bundle ID

    filter[user_bundle_id][in][] uuid[]

    Filter results by a list of user bundle IDs

    sort[] string

    Possible values: [created_at, -created_at]

    Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Responses

200: Successful response

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Loading...