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": "79cc53a1-b8d1-4831-a9c9-7ac0f1d58fe4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "53c0141a-0937-4d60-999a-57c7177bbcb6",
"company_code": "sample string 5",
"company": {
"id": "806a85e5-fc03-4494-aca5-e01fa17daf29",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-31T15:44:50.7361105+00:00",
"sales_territory_id": "f7935d78-1440-4937-8e7a-0c5204ff4a63",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e53c705b-1a69-40b0-840f-9bf9a2062850",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cf23f110-8428-4d87-a97d-bbcf43c1ffbc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c538c12-55e2-4352-a003-3e12821f2c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e486b0b2-421c-48f8-bb18-8c1b48d261d2",
"db_currency_id": "7ef88af9-31e5-4ec2-8566-5aa628b7f8b4",
"db_language_id": "486e2cd2-6215-42a2-98d6-51d7044aaabb",
"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-07-31T15:44:50.7361105+00:00"
},
"modified_dateutc": "2026-07-31T15:44:50.7361105+00:00"
},
"marketing_segment_id": "11715366-7139-4ab0-93ce-ebadd2b34d91",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0c04221c-fa60-4f83-8ec9-11e1bb25ba92",
"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": "9f375640-ec43-450d-a868-5ebf870754cc",
"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": "95097c2c-31a9-4139-99ca-74e1e8472403",
"db_country_code": "sample string 28",
"feelist_id": "917d339e-e60d-47fa-beed-43e0c33f9e8a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6f2d9cd2-14a4-449c-b246-fc9e76aaffb8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c9b26b20-1ac2-44bf-9591-51c7a140290b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-31T15:44:50.7361105+00:00",
"db_currency_id": "677ed05f-38fd-4e26-a5a5-042418bb3c69",
"db_currency_code": "sample string 10"
},
"company_type_id": "b15ab162-0690-410c-af5f-7b48aef11090",
"company_type_name": "sample string 32",
"company_type": {
"id": "79e49939-7ca0-4721-9207-a1d68c9bdc47",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8c0af76d-f38e-46d6-a0e3-87f58e91d2f4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "878803f2-de57-4355-b82d-06717a68db52",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5394e3f5-af4e-4065-ae77-472c228ba25a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "927e5701-5b21-4296-a393-f268e67b4885",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0e2a715e-1b89-45d7-bd16-dfd3a970df63",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-31T15:44:50.7361105+00:00"
},
"company_sector_id": "640246e0-dea0-4178-a81d-42119bbbe8bd",
"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": "8df732b8-0384-4534-b2f9-e0a9ecbb3463",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e5c3d10a-4b4e-4103-942b-8af90cf601a7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "77c09f6e-ac5e-4da8-a276-9169f2ff323f",
"account_manager_user_code": "sample string 56",
"company_status_id": "ea620ef3-06ad-4a35-8e36-6f5738e53408",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-31T15:44:50.7361105+00:00",
"id2": 60
},
"db_language_id": "88a791e5-c3d2-4cd3-82d5-7228ac6f5c24",
"db_language_code": "sample string 7",
"db_title_id": "ee8b31cf-88be-45e7-8ae8-25ad7b2a0c60",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-31T15:44:50.7361105+00:00",
"create_date": "2026-07-31T15:44:50.7361105+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-07-31T15:44:50.7361105+00:00"
}