Get Contact by email
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
|
Email of contact |
string |
Required |
Body Parameters :
None.
Response Information
Resource Description :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "c8e4b8ec-68be-46da-9759-fd780dfec51d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cecb1940-6ece-45ab-ad5d-16875d1b6308",
"company_code": "sample string 5",
"company": {
"id": "b5fbe8dc-49b5-4003-b7a1-9b4034cddafd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-27T05:08:07.7929181+00:00",
"sales_territory_id": "6f80441a-9c98-4341-a5aa-ed1d48d9913e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "91696474-1ba3-432d-80e0-19a10f1b04d7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2847764-a229-4437-aa3a-5716c8ddd144",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8cc01226-9f8a-4630-8a98-35f6d36a43d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "528b6a2f-4abb-4c45-a212-00dbc409c2e0",
"db_currency_id": "63c011ca-28e3-4be4-8ba7-ab905b28f5c1",
"db_language_id": "77e02039-2461-4320-8475-f6bf8cdaac16",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-27T05:08:07.7929181+00:00"
},
"modified_dateutc": "2026-08-27T05:08:07.7929181+00:00"
},
"marketing_segment_id": "3a3c9caa-fac1-4819-b44a-5dfb84f87dfd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c665b222-11e5-4382-86ee-21fa87c4aab7",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "5d9a8e9b-3711-427a-af49-72572c6047f4",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "6451556f-4b00-4d9b-b15d-9421c106834b",
"db_country_code": "sample string 28",
"feelist_id": "96c0a6e6-f5c4-4dd4-9f20-24a4c746b737",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7bde0b69-d62f-4490-8315-4fa7e9839757",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fc989446-b7b7-4658-892a-2c0b21ea8e89",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-27T05:08:07.7929181+00:00",
"db_currency_id": "bc4d924d-afc8-4a3c-a663-8654ba2accb5",
"db_currency_code": "sample string 10"
},
"company_type_id": "553278af-0e75-4208-b1de-c20acaad06d4",
"company_type_name": "sample string 32",
"company_type": {
"id": "98077a6a-7f73-497c-9217-6b6fd1dff3b1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b85d724-a3b6-496a-a384-f4e98934b19c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "956db6f7-c2d7-4547-a4a9-970354ccfc9c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "79c70b5b-c757-4965-acf7-8c35c3dfcbad",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fdfc119d-4dca-456a-8413-1c29a7b44a33",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2d1693b4-209e-4a88-b08d-ad02e6d425e1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-27T05:08:07.7929181+00:00"
},
"company_sector_id": "2d7bdcb7-50d1-42d6-9bb2-89af71d8c839",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "cd1c14e3-6d27-4a30-86c4-a9ee023d8e46",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "28020164-ce49-4f12-84f8-4791588d952e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c375d757-2684-4fb8-a87b-19d017a7b97e",
"account_manager_user_code": "sample string 56",
"company_status_id": "2e10f278-640a-4859-82f4-cde880f55243",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-27T05:08:07.7929181+00:00",
"id2": 60
},
"db_language_id": "0a097be9-b666-41d9-8694-bc6828da5455",
"db_language_code": "sample string 7",
"db_title_id": "6679f98c-6f70-44d6-961b-f9929cad58a5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-27T05:08:07.7929181+00:00",
"create_date": "2026-08-27T05:08:07.7929181+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-08-27T05:08:07.7929181+00:00"
}