Skip to main content
GET
/
core
/
v1
/
transfers
List Transfers
curl --request GET \
  --url https://api.dev.name.com/core/v1/transfers \
  --header 'Authorization: Basic <encoded-value>'
{
  "lastPage": 123,
  "nextPage": 123,
  "totalCount": 123,
  "from": 123,
  "to": 123,
  "transfers": [
    {
      "domainName": "example.com",
      "email": "admin@example.com",
      "status": "pending_transfer"
    }
  ]
}

Authorizations

Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Query Parameters

perPage
integer

Per Page is the number of records to return per request. Per Page defaults to 1,000.

page
integer

Page is which page to return.

Response

A successful response.

ListTransfersResponse returns the list of pending transfers as well as the pagination information if relevant.

totalCount
integer
required

TotalCount is total number of results.

from
integer
required

From specifies starting record number on current page.

to
integer
required

To specifies ending record number on current page.

transfers
object[]
required

Transfers is a list of pending transfers

lastPage
integer

LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.

nextPage
integer

NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.

I