Contacts : List

Aangemaakt : 01-03-2023
Laatste update: -

Omschrijving

Haal lijst op met contacten uit het account

Endpoint

GET https://api.mijndomeinreseller.nl/v2/contacts

URL parameters

Bekijk voor meer informatie over de mogelijke zoekwaarden en de pagina: Zoekopdrachten

Parameter	Datatype	Omschrijving
handle	String	Zoekwaarde voor handle van het contact
company_name	String	Zoekwaarde voor bedrijfsnaam
name	String	Zoekwaarde voor naam
address_1	String	Zoekwaarde voor adresregel 1
address_2	String	Zoekwaarde voor adresregel 2
postal_code	String	Zoekwaarde voor postcode
city	String	Zoekwaarde voor plaatsnaam
state	String	Zoekwaarde voor staat/provincie
country	String	Zoekwaarde voor land, 2-Letterige landcode volgens ISO_3166-1 voor zoeken op land
phone	String	Zoekwaarde voor telefoonnummer in e164a formaat
email	String	Zoekwaarde voor e-mailadres
status	Array	Zoekwaare voor status van het contact: mogelijke waarden: ok, pending_update, pending_validation
connections	Integer	Zoekwaarde voor aantal connecties van het contact
date_created	Datetime	Zoekwaarde voor aanmaakdatum contact, formaat: YYYY-MM-DDThh:mm:ssZ in UTC tijdzone in RFC 3339
date_last_updated	Datetime	Zoekwaarde voor datum laatste wijziging contact, formaat: YYYY-MM-DDThh:mm:ssZ in UTC tijdzone in RFC 3339
auto_delete	Boolean	Zoekwaarde voor het automatisch opruimen van een contact wanneer er geen connecties (meer) zijn
reference	String	Zoekwaarde voor de eigen referentie
sort	String	Velden waarop gesorteerd wordt. Zie ook de pagina: Zoekopdrachten sorteren
page	Integer	Het paginanummer van de te tonen pagina, standaard waarde: 1. Zie ook de pagina: Paginering
per_page	Integer	Het aantal te tonen zoekresultaten per pagina, standaard waarde: 50. Zie ook de pagina: Paginering

Antwoord

HTTP status code: 200 Ok

Parameter	Type	Omschrijving
Array: data[] met object:
handle	String	Handle van het contact
company_name	String	Bedrijfsnaam van het contact
name	String	Naam van het contact
address_1	String	Adresregel 1 van het contact
address_2	String	Adresregel 2 van het contact
postal_code	String	Postcode van het contact
city	String	Plaatsnaam van het contact
state	String	Staat/provincie van het contact
country	String	Land van het contact, 2-Letterige landcode volgens ISO_3166-1 voor zoeken op land
phone	String	Telefoonnummer van het contact, e164a formaat
email	String	E-mailadres van het contact
status	Array	Status van het contact: ok: Het contact is actief pending_update: Er is een update in behandeling pending_validation: Er is een validatie in behandeling
connections	String	Aantal connecties met domeinnamen
date_created	Datetime	Datum en tijdstip waarop het contact werd aangemaakt in UTC tijdzone in RFC 3339
date_last_updated	Datetime	Datum en tijdstip waarop het contact voor het laatst werd gewijzigd in UTC tijdzone in RFC 3339
auto_delete	Boolean	Of het contact automatisch wordt opgeruimd indien er geen connecties (meer) zijn
Object: pagination
current_page	Integer	Huidige pagina
per_page	Integer	Aantal resultaten per pagina
total_pages	Integer	Totaal aantal pagina's
total_results	Integer	Totaal aantal resultaten

Voorbeelden

Beschrijving:
Haal lijst met contacten op

PHP
cURL

Opdracht in PHP:

<?php
$env      = "live"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/contacts";
$api_host = $env == "live" ? "https://api.mijndomeinreseller.nl" : "https://api-test.mijndomeinreseller.nl";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key"));
$output = curl_exec($ch);
curl_close($ch);

echo $output;

Opdracht in cURL:

curl -H "Authorization: Bearer XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
https://api-test.mijndomeinreseller.nl/v2/contacts

Antwoord:

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
  "data": [
    {
      "handle": "AARP-0002",
      "company_name": "",
      "name": "P Jansen",
      "address_1": "Kerkstraat 1",
      "address_2": "app 2",
      "postal_code": "1234 AB",
      "city": "Almere",
      "state": "Flevoland",
      "country": "NL",
      "phone": "+31.612345678",
      "email": "info@mijndomeinreseller.nl",
      "connections": 2,
      "date_created": "2020-05-26T08:44:53Z",
      "date_last_updated": "2021-03-13T12:48:12Z",
      "auto_delete": true,
      "status": [
        "ok"
      ]
    },
    {
      "handle": "AARP-0003",
      "company_name": "",
      "name": "Q Jansen",
      "address_1": "Grote Markt 2",
      "address_2": "",
      "postal_code": "1234 BC",
      "city": "Almere",
      "state": "",
      "country": "NL",
      "phone": "+31.687654321",
      "email": "info@mijndomeinreseller.nl",
      "connections": 26,
      "date_created": "2020-05-24T03:18:12Z",
      "date_last_updated": "2021-02-28T16:14:28Z",
      "auto_delete": true,
      "status": [
        "ok","pending_update"
      ]
    },
  ],
  pagination": {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_results": 2
  }
}

Beschrijving:
Haal lijst met contacten op waarbij het aantal connecties met domeinnamen groter is dan 5, aflopend gesorteerd op het aantal connecties

PHP
cURL

Opdracht in PHP:

<?php
$env      = "live"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/contacts?connections=>5&sort=-connections";
$api_host = $env == "live" ? "https://api.mijndomeinreseller.nl" : "https://api-test.mijndomeinreseller.nl";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key"));
$output = curl_exec($ch);
curl_close($ch);

echo $output;

Opdracht in cURL:

curl -H "Authorization: Bearer XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
"https://api-test.mijndomeinreseller.nl/v2/contacts?connections=>5&sort=-connections"

Antwoord:

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
  "data": [
    {
      "handle": "AARP-0002",
      "company_name": "",
      "name": "P Jansen",
      "postal_code": "1234 AB",
      "city": "Almere",
      "country": "NL",
      "phone": "+31.612345678",
      "email": "info@mijndomeinreseller.nl",
      "connections": 10,
      "date_created": "2020-05-26T08:44:53Z",
      "date_last_updated": "2021-03-13T12:48:12Z",
      "auto_delete": true,
      "status": [
        "ok"
      ]
    },
  ],
  pagination": {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_results": 1
  }
}

Beschrijving:
Haal lijst met contacten op waarbij het e-mailadres onderdeel is van de domeinnaam "@mijndomeinreseller.nl", oplopend gesorteerd op "emailadres", daarna afgelopend op handle

PHP
cURL

Opdracht in PHP:

<?php
$env      = "live"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/contacts?email=%@mijndomeinreseller.nl&sort=email,-handle";
$api_host = $env === "live" ? "https://api.mijndomeinreseller.nl" : "https://api-test.mijndomeinreseller.nl";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key"));
$output = curl_exec($ch);
curl_close($ch);

echo $output;

Opdracht in cURL:

curl -H "Authorization: Bearer XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
"https://api-test.mijndomeinreseller.nl/v2/contacts?email=%@mijndomeinreseller.nl&sort=email,-handle"

Antwoord:

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
  "data": [
    {
      "handle": "AARP-0002",
      "company_name": "",
      "name": "P Jansen",
      "postal_code": "1234 AB",
      "city": "Almere",
      "country": "NL",
      "phone": "+31.612345678",
      "email": "info@mijndomeinreseller.nl",
      "connections": 2,
      "date_created": "2020-05-26T08:44:53Z",
      "date_last_updated": "2021-03-13T12:48:12Z",
      "auto_delete": true,
      "status": [
        "ok","pending_validation"
      ]
    }
  ],
  pagination": {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_results": 1
  }
}

Contacts : List

Omschrijving

Endpoint

URL parameters

Antwoord

Voorbeelden

API Documentatie