---
title: "Return a transfer module's schema"
method: GET
path: "/transfer_module_schema"
tags: ["Transfers", "Transfer Configuration"]
---

# Return a transfer module's schema

`GET /transfer_module_schema`

This function retrieves a transfer module's key structure.

**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

- `module` 'AccountLocal' | 'AccountRemoteRoot' | 'AccountRemoteUser' | 'FeaturesListRemoteRoot' | 'LegacyAccountBackup' | 'PackageRemoteRoot', required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `schema` object — An object containing information about the schema's keys.
      - `keys` object — An object containing the schema's keys.
      - `primary` string[] — The schema's primary key.
      - `required` string[] — A list of schema's required keys.
  - `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)