/migrations/{id}/mailboxes (GET)

GET

/migrations/{id}/mailboxes

const url = 'https://example.com/api/v1/migrations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mailboxes';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/migrations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mailboxes \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Default Response

application/json

Array<object>

object

required

string

jobId

required

string

sourceAddress

required

string

targetMailboxId

required

Any of:

string
null

string

targetAddress

required

Any of:

string
null

string

state

required

string

Allowed values: pending running done failed skipped

progress

required

object

foldersTotal

required

integer

<= 9007199254740991

foldersDone

required

integer

<= 9007199254740991

messagesTotal

required

integer

<= 9007199254740991

messagesDone

required

integer

<= 9007199254740991

messagesSkipped

required

integer

<= 9007199254740991

bytesDone

required

integer

<= 9007199254740991

errorCode

required

Any of:

string
null

string

Allowed values: auth connection tls quota rate_limited folder source_missing target_missing cancelled unknown

errorDetail

required

Any of:

string
null

string

lastRunAt

required

Any of:

string
null

string

hasSecret

required

boolean

Example

[
  {
    "state": "pending",
    "errorCode": "auth"
  }
]