Company Identifiers

List Company Identifier Migrations

List the migrations of an identifier between Peppol providers, newest first.

List the migrations of an identifier between Peppol providers, newest first. Use it to see whether a stored migration key is still pending, has completed, or failed and why.

GET
/api/v1/companies/{companyId}/identifiers/{identifierId}/migrations
AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Path Parameters

companyId*string

The ID of the company the identifier belongs to

identifierId*string

The ID of the identifier

Response Body

application/json

application/json

application/json

curl -X GET "https://app.recommand.eu/api/v1/companies/string/identifiers/string/migrations"
{
  "success": true,
  "migrations": [
    {
      "id": "pm_01JQZ8X0M4T7RB6K9V2NDHW3PA",
      "companyId": "c_01JQZ8X0M4T7RB6K9V2NDHW3PA",
      "scheme": "0208",
      "identifier": "1012081766",
      "direction": "inbound",
      "status": "pending",
      "migrationKey": "string",
      "errorMessage": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "completedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}
{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}