Skip to main content

List action requirements for a porting order

GET 
/porting_orders/:porting_order_id/action_requirements

Returns a list of action requirements for a specific porting order.

Request ​

Path Parameters

    porting_order_id stringrequired

    The ID of the porting order

Query Parameters

    page object

    Consolidated page parameter (deepObject style). Originally: page[size], page[number]

    filter object

    Consolidated filter parameter (deepObject style). Originally: filter[id][in][], filter[requirement_type_id], filter[action_type], filter[status]

    sort object

    Consolidated sort parameter (deepObject style). Originally: sort[value]

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id string

    Identifies the action requirement

    record_type string

    Possible values: [porting_action_requirement]

    Identifies the type of the resource

    porting_order_id string

    The ID of the porting order this action requirement belongs to

    requirement_type_id string

    The ID of the requirement type

    action_type string

    The type of action required

    action_url stringnullable

    Optional URL for the action

    status string

    Possible values: [created, pending, completed, cancelled, failed]

    Current status of the action requirement

    cancel_reason stringnullable

    Reason for cancellation if status is 'cancelled'

    created_at date-time

    ISO 8601 formatted date-time indicating when the resource was created

    updated_at date-time

    ISO 8601 formatted date-time indicating when the resource was updated

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

404: Porting order not found

500: Internal server error

Request samples

curl -L 'https://api.telnyx.com/v2/porting_orders/:porting_order_id/action_requirements' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "porting_action_requirement",
      "porting_order_id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "requirement_type_id": "53970723-fbff-4f46-a975-f62be6c1a585",
      "action_type": "document_upload",
      "action_url": "https://example.com/action",
      "status": "created",
      "cancel_reason": null,
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}