Sign in

v53

OpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB
Porting Orders

List action requirements for a porting order

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

get/porting_orders/{porting_order_id}/action_requirements

Path parameters

porting_order_idstring required

The ID of the porting order

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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

action_type'au_id_verification'

Filter action requirements by action type

idstring[]

Filter action requirements by a list of IDs

requirement_type_idstring uuid

Filter action requirements by requirement type ID

status'created' | 'pending' | 'completed' | 'cancelled' | 'failed'

Filter action requirements by status

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

value'created_at' | '-created_at' | 'updated_at' | '-updated_at'

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

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

{
  "value": "created_at"
}

Response

Successful response

Example response

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