Read CRM Notice

Pobranie komunikatów CRM

GET /crm_notice

Query Parameters

Możliwe parametry w URL:

Parametr	Domyślnie	Przykład	Opis
limit	1000	1000	Limit pobranych rekordów
offset	0	2	Od którego rekordu
sort	NULL	name	Parametr do sortowania
dir	NULL	asc	Kierunek sortowania
filter	NULL	`[{"property": "from_date", "operator": "gt", "value": "2021-12-05 14:00:00"}]`	Filtrowanie po parametrach. Parametry obowiązkowe: `property` i `value`, opcjonalne: `operator`

Dostępne opcje dla parametru sort:

asc: sortowanie rosnące
desc: sortowanie malejące

Dostępne property dla parametru filter:

crm_id
created_by_tenant_user_id_list
contact_id_list
organization_id_list
from_date/to_date
created_date
last_modified_date

Opis pól znajdziesz w CRMNotice

Parametr filter musi być listą obiektów przekształconą w ciąg JSON zakodowany w UTF-8.

Przykład przekształcenia:

encodeURI(JSON.stringify([{"property": "from_date", "operator": "gt", "value": "2021-12-05 14:00:00"}]))

Przekształcona wartość:

%5B%7B%22property%22:%22name%22,%22value%22:%KomunikatTestowy%7D%5D

Response Body

{
    "data": <CRMNotice>
}

Nazwa	Rodzaj	Opis	Zasób
data	`<CRMNotice>`	Obiekt	CRMNotice

Response Code

Status	Opis
200	Rekordy zostały pobrane pomyślnie
400	Nieprawidłowe dane
404	Nie znaleziono zasobu

Example

CURLPYTHONPHP

curl -X GET \
$CONPEEK_URL/crm_notice \
-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_notice")

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

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

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => getenv("CONPEEK_URL")."/crm_notice",
    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;
}