Read Contacts

Pobranie listy kontaktów

GET /crm/{crm_id}/contact

URL Parameters

Nazwa	Rodzaj	Przykład	Opis
crm_id	<STRING>	597c789f68df7b60af68j98m	Identyfikator bazy CRM

Query Parameters

Możliwe parametry w URL:

Parametr	Domyślnie	Przykład	Opis
limit	1000	10000	Limit pobranych rekordów
offset	0	0	Od którego rekordu
sort	NULL	email	Parametr do sortowania
dir	NULL	asc	Kierunek sortowania, dostępne asc - rosnąco, desc - malejąco
filter	NULL	[{"property": "email", "value": "example@xyz.com"}]	Filtrowanie po parametrach, kazdy obiekt musi posiadać klucz property i value

Dostępne parametry dla filter:

• organization_id - <STRING>
• firstname - <STRING>
• surname - <STRING>
• contact_identifier - <STRING>
• tag_list - <LIST<STRING>>
• web_user - <STRING>
• tele_id - <STRING>
• email - <STRING>
• number_list - <LIST<STRING>>
• country - <STRING>
• province - <STRING>
• city - <STRING>
• postcode - <STRING>
• address_1 - <STRING>
• address_2 - <STRING>
• lifecycle_stage_list - <LIST<INTEGER>>
• custom_{NAZWA_PARAMETRU} - <STRING>

Response Body

{
    "data": <LIST<CRMContact>>
}

Nazwa	Rodzaj	Opis	Zasób
data	<LIST<CRMContact>>	Lista obiektów	CRMContact

Response Code

Status	Opis
200	Rekordy zostały pobrane pomyślnie
403	Nie można wykonać takiej akcji
404	Nie znaleziono zasobu

Example

CURLPYTHONPHP

curl -X GET \
$CONPEEK_URL/crm/597c789f68df7b60af68j98m/contact \
-H 'Authorization: '$CONPEEK_KEY \
-H 'Content-Type: application/json'

import requests
import os
from urllib import parse

url = parse.urljoin(os.environ["CONPEEK_URL"], "/crm/%(crm_id)s/contact" % {
    "crm_id": "597c789f68df7b60af68j98m",
})

headers = {
    'Content-Type': "application/json",
    'Authorization': os.environ["CONPEEK_KEY"]
}

response = requests.request("GET", url, headers=headers)
print(response.text)

<?php
$curl = curl_init();

$crm_id = "597c789f68df7b60af68j98m";

curl_setopt_array($curl, array(
    CURLOPT_URL => getenv("CONPEEK_URL")."/crm/$crm_id/contact",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: ".getenv("CONPEEK_KEY"),
        "Content-Type: application/json"
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}