Skip to main content

Eksport kontaktów

Metoda pozwala na eksport danych o kontaktach zapisanych w CRM.

Dane możliwe do wyeksportowania dla kontaktów (osób)

Właściwość

Wartość

Opis

firstName

string

Imię.

middleName

null | string

Drugie imię.

lastName

string

Nazwisko.

pesel

null | PESEL

PESEL.

description

null | string

Opis.

phone1

null | phone

Numer telefonu 1.

phone1Name

null | string

Nazwa numeru telefonu 1.

phone2

null | phone

Numer telefonu 2.

phone2Name

null | string

Nazwa numeru telefonu 2.

phone3

null | phone

Numer telefonu 3.

phone3Name

null | string

Nazwa numeru telefonu 3.

email1

null | email

Adres e-mail 1.

email1Name

null | string

Nazwa adresu e-mail 1.

email2

null | email

Adres e-mail 2.

email2Name

null | string

Nazwa adresu e-mail 2.

email3

null | email

Adres e-mail 3.

email3Name

null | string

Nazwa adresu e-mail 3.

idDocType

null | string

Dokument potwierdzający tożsamość.

idDocNumber

null | string

Numer dokumentu tożsamości.

idDocIssuer

null | string

Organ wydający dokument tożsamości.

addresses

null | array

Adresy powiązane z osobą, maksymalnie 3 adresy.

addresses.*.name

string

Nazwa adresu (np. Siedziby, korespondencyjny).

addresses.*.street

null | string

Ulica.

addresses.*.city

null | string

Miasto.

addresses.*.postcode 

null | string

Kod pocztowy.

addresses.*.building_no

null | string

Numer budynku.

addresses.*.local_no

null | string

Numer lokalu.

addresses.*.voivodeship

null | string

Województwo.

addresses.*.country

null | string

Kraj.

addresses.*.district

null | string

Powiat.

organisations

null | array

Powiązanie z organizacją istniejącą w bazie CRM.

organisations.*

uuid

Organizacja.

supervisors

null | array

Opiekunowie i obserwatorzy.

supervisors.*.user

uuid

Użytkownik wskazany jako opiekun lub obserwator.

supervisors.*.role

string

Rola użytkownika (manager- opiekun, watcher- obserwator).

customFields.*.uuid

uuid

Własne pola utworzone dla profilu organizacji.
Dane możliwe do wyeksportowania dla kontaktów (organizacji)

Właściwość

Wartość

Opis

name

string

Nazwa.

description

null | string

Opis.

phone1

null | phone

Numer telefonu 1.

phone1Name

null | string

Nazwa numeru telefonu 1.

phone2

null | phone

Numer telefonu 2.

phone2Name

null | string

Nazwa numeru telefonu 2.

phone3

null | phone

Numer telefonu 3.

phone3Name

null | string

Nazwa numeru telefonu 3.

email1

null | email

Adres e-mail 1.

email1Name

null | string

Nazwa adresu e-mail 1.

email2

null | email

Adres e-mail 2.

email2Name

null | string

Nazwa adresu e-mail 2.

email3

null | email

Adres e-mail 3.

email3Name

null | string

Nazwa adresu e-mail 3.

nip

null | nip

NIP podmiotu.

regon

null | regon

REGON podmiotu.

registry

null | string

Rejestr właściwy dla podmiotu (KRS, CEIDG, REGON).

addresses

null | array

Adresy powiązane z podmiotem, maksymalnie 3 adresy.

addresses.*.name

string

Nazwa adresu (np. Siedziby, korespondencyjny).

addresses.*.street

null | string

Ulica.

addresses.*.city

null | string

Miasto.

addresses.*.postcode 

null | string

Kod pocztowy.

addresses.*.building_no

null | string

Numer budynku.

addresses.*.local_no

null | string

Numer lokalu.

addresses.*.voivodeship

null | string

Województwo.

addresses.*.country

null | string

Kraj.

addresses.*.district

null | string

Powiat.

people

null | array

Osoby powiązane z podmiotem (osoby z kontaktów).

people.*

uuid

Osoba powiązana (osoba z kontaktów).

supervisors

null | array

Opiekunowie i obserwatorzy.

supervisors.*.user

uuid

Użytkownik wskazany jako opiekun lub obserwator.

supervisors.*.role

string

Rola użytkownika (manager- opiekun, watcher- obserwator).

customFields.*.uuid

uuid

Własne pola utworzone dla profilu organizacji.

Metoda: POST
Adres URL (dla osób): {twoja_nazwa}.ccrm.pl/publicApi/people/export
Adres URL (dla organizacji): {twoja_nazwa}.ccrm.pl/publicApi/organisations/export

Struktura żądania

Właściwość

Wartość

Opis

columns

array


columns.*

string

Nazwa kolumny.

pushUrl

string

Adres URL na który API ma wysłać link do pobrania wygenerowanego pliku.
Przykład żądania 
{
	"columns":[
		"firstName",
		"middleName",
		"lastName"
	],
	"pushUrl":"{adres_twojego_api_do_wysyłki_pliku}"
}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

string

otherData

object

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}

Po wygenerowaniu pliku, API wyśle na wskazany w żądaniu adres URL (metodą POST) link do pobrania pliku o następującej strukturze:

{
	url: "https://{twoja_nazwa}.ccrm.pl/api/storage/download/d333a333-f9f8-4d33-a333-fb3b3333attb"
}

Aby pobrać plik z linku, należy korzystać z tego samego adresu IP, który był użyty przy wysłaniu żądania o jego wygenerowanie.

Back to top