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": "1a63536c-1090-4d9e-a173-1047ca96f6ed",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9a8d0d27-6fdf-465c-bc26-0a8caecf2965",
"company_code": "sample string 5",
"company": {
"id": "7bd4ca2a-68c1-4c9b-9852-d020ada6b85c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-08T05:54:38.710992+00:00",
"sales_territory_id": "88f4d7ed-fb61-4371-aa0e-4402f0295506",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "55111a39-ca17-4ebd-a601-c3251698cacf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4d661255-9fa7-4ad6-b30a-8e73acf915d2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b2d41b83-9fb6-4c8c-b927-ed2357cf62f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7699719-5cef-418d-8dda-b4657084f265",
"db_currency_id": "b6c12ac3-7c4d-4da5-97ba-a0f329c43411",
"db_language_id": "64345380-bdb0-49e1-943f-835a2716d68b",
"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-06-08T05:54:38.710992+00:00"
},
"modified_dateutc": "2026-06-08T05:54:38.710992+00:00"
},
"marketing_segment_id": "847f9e8b-3747-4091-9a93-2429709f83be",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d10bc64f-f2d1-48fc-8f5f-61b9573bb867",
"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": "5446d230-6637-4440-acae-68021b9dec53",
"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": "d4d1a03c-45ec-4239-a9fe-a8eec57d7882",
"db_country_code": "sample string 28",
"feelist_id": "5bd4e1dd-0cb0-4c84-991e-47548ae38173",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "017f689b-1bd8-4aed-9661-524714711661",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f5b8182f-8ebd-4023-85b5-f05c91cf67dd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-08T05:54:38.710992+00:00",
"db_currency_id": "c4d05fc1-1660-42d5-92c0-2b9a4578d609",
"db_currency_code": "sample string 10"
},
"company_type_id": "825ce939-9c64-46a4-94b6-919715e6ad12",
"company_type_name": "sample string 32",
"company_type": {
"id": "acb5ce15-bee9-47aa-97c0-7dd5e4073546",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b883317-896d-4a70-ae6c-3ae70eba9c07",
"sales_organization_code": "sample string 5"
},
"db_language_id": "89615607-b2cf-47b0-9d1b-1a63ffb1d38b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a25dd316-a0e4-43bb-b991-367e70a3f903",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "56dcb487-06fd-4355-baf0-1c21ec76ea85",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f18b31ed-15b3-4cdc-9785-53cac7e9379e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-08T05:54:38.710992+00:00"
},
"company_sector_id": "6a123282-eace-4367-88d4-f31a3843a4b3",
"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": "b47623d7-8573-488b-a30f-a6c2040bb554",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9ee6a489-d4d8-4354-ae11-8a5bd5473971",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "63582ed6-fd2a-4418-9437-1afdcda06524",
"account_manager_user_code": "sample string 56",
"company_status_id": "f147f7a0-09c2-487c-a9ae-3868370c3b3e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-08T05:54:38.710992+00:00",
"id2": 60
},
"db_language_id": "2b6cc0cb-bd02-4796-9e30-2742389aee34",
"db_language_code": "sample string 7",
"db_title_id": "d5971280-0108-4185-8f47-fd4e96694af5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-08T05:54:38.710992+00:00",
"create_date": "2026-06-08T05:54:38.710992+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-06-08T05:54:38.710992+00:00"
}