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[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

    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

    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

Schema

    data

    object[]

  • Array [

  • id uuid

    Uniquely identifies this phone number configuration

    user_bundle_id uuid

    Identifies the associated user bundle

    porting_phone_number_id uuid

    Identifies the associated porting phone number

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

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

Loading...