Skip to main content
GET
/
plans
/
{plan_id}
/
migrations
List migrations
curl --request GET \
  --url https://api.withorb.com/v1/plans/{plan_id}/migrations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "plan_id": "<string>",
      "effective_time": "2023-12-25",
      "status": "not_started"
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

plan_id
string
required

Query Parameters

limit
integer
default:20

The number of items to fetch. Defaults to 20.

Required range: 1 <= x <= 100
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

Response

OK

data
PlanVersionChange · object[]
required
pagination_metadata
object
required