v1

latestSwagger 2.02026-08-041113661.2 MB
ResellerService

Get reseller

get/v1beta/resellers

Query parameters

with_additional_databoolean

Retrieves objects with (1) or without (0) additional data.

with_statisticsboolean

Indicates if reseller statistics should be retrieved.

with_settingsboolean

Indicates if reseller settings should be retrieved.

with_contactsboolean

Indicates if reseller contacts should be retrieved.

Response

A successful response.

codeinteger
descstring
maintenanceboolean

Example response

{
  "code": 0,
  "data": {
    "additional_data": {
      "cif_nif_number": "12345678",
      "gstin": "123456789aaa",
      "internal_reference": ""
    },
    "address": {
      "city": "Test city",
      "country": "NL",
      "number": "123",
      "state": "Testprovince",
      "street": "Test street",
      "suffix": "A",
      "zipcode": "1235 XX"
    },
    "balance": 99999,
    "comments": "Some comment here",
    "company_name": "Example company",
    "contacts": [
      {
        "additional_data": {
          "birth_city": "Test city",
          "birth_date": "1969-12-31",
          "social_security_number": "12326178T"
        },
        "address": {
          "city": "Test city",
          "country": "NL",
          "number": "123",
          "state": "Testprovince",
          "street": "Test street",
          "suffix": "A",
          "zipcode": "1235 XX"
        },
        "api_access_enabled": true,
        "api_client_ip_list": {
          "allow": [
            "127.0.0.1"
          ],
          "deny": [
            "127.0.0.1"
          ]
        },
        "auth_type": "simple",
        "comments": "",
        "company_name": "Example company",
        "email": "test@mail.tld",
        "hash_changed_at": "2019-03-25 10:17:02",
        "id": 123456789,
        "is_active": false,
        "last_api_call_at": "2019-03-25 10:17:01",
        "last_login_at": "2019-04-12 11:58:39",
        "locale": "nl_NL",
        "name": {
          "first_name": "Test",
          "full_name": "Test Person",
          "initials": "T P",
          "last_name": "Person",
          "prefix": "Mr"
        },
        "password_change_declined_at": "2019-03-23 12:32:15",
        "password_changed_at": "2019-03-25 10:17:00",
        "phone": {
          "area_code": "111",
          "country_code": "+03",
          "subscriber_number": "123456"
        },
        "rcp_client_ip_list": {
          "allow": [
            "127.0.0.1"
          ],
          "deny": [
            "127.0.0.1"
          ]
        },
        "reseller_id": 12345,
        "role": "admin",
        "secret_key": "SECRETKEYVALUE",
        "username": "user_name",
        "vat": "XX123456789X12"
      }
    ],
    "email": "",
    "fax": {
      "area_code": "",
      "country_code": "",
      "subscriber_number": ""
    },
    "id": 123456789,
    "locale": "nl_NL",
    "name": {
      "first_name": "Test",
      "full_name": "Test Person",
      "initials": "T P",
      "last_name": "Person",
      "prefix": "Mr"
    },
    "phone": {
      "area_code": "111",
      "country_code": "+03",
      "subscriber_number": "123456"
    },
    "reserved_balance": 1111.11,
    "settings": {
      "av_handle": "XX123456-XX",
      "claims_confirm_url": "http://www.domain.tld/confirm-tm_claims.php?domainId=%%domainId%%&domain=%%domain%%&code=%%authCode%%",
      "claims_email_subject": "Hi there! You need to accept registration for %%domain%%!",
      "claims_reseller_name": "Jon Doe's Webhosting!!",
      "claims_sender_email": "test@mail.tld",
      "currency": "EUR",
      "default_domain_billing_handle": "XX123456-XX",
      "default_domain_reseller_handle": "XX123456-XX",
      "foa_confirm_url": "",
      "foa_email_subject": "",
      "foa_reseller_name": "",
      "foa_sender_email": "",
      "foa_terms_conditions_url": "",
      "is_auto_renew_enabled": false,
      "is_custom_nses_enabled": false,
      "ive2_customized_body": "",
      "ive2_email_subject": "[URGENT REMINDER] Request for e-mail address verification",
      "ive_confirm_url": "http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%",
      "ive_customized_body": "",
      "ive_email_subject": "Request for e-mail address verification",
      "ive_reseller_name": "sdasd",
      "ive_sender_email": "do-not-reply@registrar.eu",
      "jurisdiction": "EU",
      "language": "EN",
      "maximum_credit": 20000,
      "maximum_credit_card_payment": 15000,
      "maximum_i_deal_payment": 1000000,
      "maximum_western_union_payment": 1000,
      "minimum_payment": 20,
      "minimum_western_union_payment": 500,
      "pay_methods": [
        "ideal"
      ],
      "payment_methods": [
        {
          "name": "ideal",
          "settings": {
            "limit": {
              "maximum": {
                "aud": 0,
                "bgn": 0,
                "brl": 0,
                "cad": 0,
                "chf": 0,
                "cny": 0,
                "czk": 0,
                "dkk": 0,
                "eek": 0,
                "eur": 0,
                "gbp": 0,
                "ghs": 0,
                "hkd": 0,
                "hrk": 0,
                "huf": 0,
                "idr": 0,
                "ils": 0,
                "inr": 0,
                "jpy": 0,
                "krw": 0,
                "lkr": 0,
                "ltl": 0,
                "lvl": 0,
                "mxn": 0,
                "myr": 0,
                "nok": 0,
                "nzd": 0,
                "php": 0,
                "pln": 0,
                "ron": 0,
                "rub": 0,
                "sek": 0,
                "sgd": 0,
                "thb": 0,
                "try": 0,
                "usd": 0,
                "zar": 0
              },
              "minimum": {
                "aud": 0,
                "bgn": 0,
                "brl": 0,
                "cad": 0,
                "chf": 0,
                "cny": 0,
                "czk": 0,
                "dkk": 0,
                "eek": 0,
                "eur": 0,
                "gbp": 0,
                "ghs": 0,
                "hkd": 0,
                "hrk": 0,
                "huf": 0,
                "idr": 0,
                "ils": 0,
                "inr": 0,
                "jpy": 0,
                "krw": 0,
                "lkr": 0,
                "ltl": 0,
                "lvl": 0,
                "mxn": 0,
                "myr": 0,
                "nok": 0,
                "nzd": 0,
                "php": 0,
                "pln": 0,
                "ron": 0,
                "rub": 0,
                "sek": 0,
                "sgd": 0,
                "thb": 0,
                "try": 0,
                "usd": 0,
                "zar": 0
              }
            },
            "transaction_fee": 0,
            "transaction_fee_absolute": 0
          }
        }
      ],
      "preregistered_domain_priorities": "[]",
      "recurring_payment_methods": [
        {
          "name": "ideal",
          "settings": {
            "limit": {
              "maximum": {
                "aud": 0,
                "bgn": 0,
                "brl": 0,
                "cad": 0,
                "chf": 0,
                "cny": 0,
                "czk": 0,
                "dkk": 0,
                "eek": 0,
                "eur": 0,
                "gbp": 0,
                "ghs": 0,
                "hkd": 0,
                "hrk": 0,
                "huf": 0,
                "idr": 0,
                "ils": 0,
                "inr": 0,
                "jpy": 0,
                "krw": 0,
                "lkr": 0,
                "ltl": 0,
                "lvl": 0,
                "mxn": 0,
                "myr": 0,
                "nok": 0,
                "nzd": 0,
                "php": 0,
                "pln": 0,
                "ron": 0,
                "rub": 0,
                "sek": 0,
                "sgd": 0,
                "thb": 0,
                "try": 0,
                "usd": 0,
                "zar": 0
              },
              "minimum": {
                "aud": 0,
                "bgn": 0,
                "brl": 0,
                "cad": 0,
                "chf": 0,
                "cny": 0,
                "czk": 0,
                "dkk": 0,
                "eek": 0,
                "eur": 0,
                "gbp": 0,
                "ghs": 0,
                "hkd": 0,
                "hrk": 0,
                "huf": 0,
                "idr": 0,
                "ils": 0,
                "inr": 0,
                "jpy": 0,
                "krw": 0,
                "lkr": 0,
                "ltl": 0,
                "lvl": 0,
                "mxn": 0,
                "myr": 0,
                "nok": 0,
                "nzd": 0,
                "php": 0,
                "pln": 0,
                "ron": 0,
                "rub": 0,
                "sek": 0,
                "sgd": 0,
                "thb": 0,
                "try": 0,
                "usd": 0,
                "zar": 0
              }
            },
            "transaction_fee": 0,
            "transaction_fee_absolute": 0
          }
        }
      ],
      "renew_notification_days": [
        1
      ],
      "renew_notification_every_week": false,
      "tac_contract": {
        "is_signed": false,
        "name": "opensign_terms_and_conditions",
        "signed_at": "2014-07-16 15:22:48",
        "type": "opensign"
      },
      "tags": [
        "VIPCUSTOMER"
      ],
      "transaction_fee": {
        "bank": 0,
        "credit_card": 3,
        "ideal": 0,
        "paypal": 5,
        "western_union": 0,
        "yandex": 5
      },
      "type": "normal"
    },
    "statistics": {
      "currency": {
        "modified": "2010-08-01 9:30:54"
      },
      "customer": {
        "modified": "2019-05-03 13:23:01",
        "total": 999
      },
      "dns": {
        "total": 999
      },
      "domain": {
        "by_status": {
          "act": 7,
          "fai": 419,
          "nsr": 0,
          "pen": 0,
          "rej": 5,
          "req": 15
        },
        "total": 999
      },
      "level": 3,
      "license": {
        "total": 999
      },
      "spam_experts": {
        "activated_at": "2012-10-29 10:48:30",
        "created_at": "2012-10-29 10:48:30",
        "exists": false,
        "expired_at": "2016-04-05 8:50:34",
        "incoming_count": 0,
        "incoming_limit": 10,
        "outgoing_count": 0,
        "outgoing_limit": 1,
        "status": "deleted",
        "with_outgoing_filter": false
      },
      "ssl": {
        "by_status": {
          "act": 7,
          "fai": 419,
          "nsr": 0,
          "pen": 0,
          "rej": 5,
          "req": 15
        },
        "total": 999
      }
    },
    "status": "new",
    "tier": 3,
    "vat": "",
    "vatperc": 21
  },
  "desc": ""
}