webmaster

Get a list of users with the “site owner” type.

Request format

Note

Pagination available.

https://adfox.yandex.com/api/v1
  ? object=account
  & action=list
  & actionObject=webmaster
  & [actionObjectID=<integer>]

actionObjectID

To get data for only one site owner, specify their ID.

Default value: 0 (display the list of all users with the “site owner” type).

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <account>{string}</account>
    <company>{string}</company>
    <firstName>{string}</firstName>
    <lastName>{string}</lastName>
    <eMail>{string}</eMail>
    <country>{string}</country>
    <state>{string}</state>
    <city>{string}</city>
    <ZIPCode>{string}</ZIPCode>
    <address1>{string}</address1>
    <address2>{string}</address2>
    <phone>{string}</phone>
    <fax>{string}</fax>
    <dateAdded>{string}</dateAdded>
    <WMZ>{string}</WMZ>
    <WMZProtection>{string}</WMZProtection>
    <YandexMoney>{string}</YandexMoney>
    <comments>{string}</comments>
  </row0>
</data>
</result>
</response>

Response parameters

code

Request processing status. If the value is 0, the request was completed successfully. For the key, see Error handling.

rows

Number of items in the response tree.

rowN

Item number in the response tree, where N is a number from 0 to rows-1 (where rows is the total number of items in the response).

ID

Unique ID of the user with the “site owner” type.

account

Site owner's account.

company

Company name.

firstName

Site owner's first name.

lastName

Site owner's last name.

eMail

Email address that the site owner's access is registered to.

country

Country.

state

Region.

city

City.

ZIPCode

Postal code.

address1

Address.

address2

Address (continued).

phone

Phone number.

fax

Fax.

dateAdded

Date when the user with “site owner” type was added.

WMZ

WebMoney wallet number.

WMZProtection

WebMoney wallet security code.

YandexMoney

Yandex Money wallet number.

comments

Comments.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=webmaster

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>203478</ID>
    <account>ivanov</account>
    <company>Example LLC</company>
    <firstName>Ivan</firstName>
    <lastName>Ivanov</lastName>
    <eMail>ivanov@yandex.com</eMail>
    <country>Russian Federation</country>
    <state/>
    <city>Moscow</city>
    <ZIPCode>123456</ZIPCode>
    <address1>ul. Stroiteley, 3</address1>
    <address2>room 305</address2>
    <phone>+7 (495) 555-55-55</phone>
    <fax/>
    <dateAdded>0000-00-00</dateAdded>
    <WMZ/>
    <WMZProtection/>
    <YandexMoney/>
    <comments/>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the webmaster object: