---
title: "Return transfer session's status"
method: GET
path: "/get_transfer_session_state"
tags: ["Transfers", "Transfer Monitoring"]
---

# Return transfer session's status

`GET /get_transfer_session_state`

This function retrieves the state of a transfer session.

**Note:**

For more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.

## Query parameters

- `transfer_session_id` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `state_name` 'TRANSFER_PENDING' | 'TRANSFER_INPROGRESS' | 'RESTORE_PENDING' | 'RESTORE_INPROGRESS' | 'RUNNING' | 'PAUSED' | 'PENDING' | 'COMPLETED' | 'ABORTED' | 'FAILED' — The transfer session's state. * `TRANSFER_PENDING` * `TRANSFER_INPROGRESS` * `RESTORE_PENDING` * `RESTORE_INPROGRESS` * `RUNNING` * `PAUSED` * `PENDING` * `COMPLETED` * `ABORTED` * `FAILED`
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)