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": "7f23f59f-94f6-4390-9c53-0a6cad501834",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3e413244-7fa7-410f-acfc-65580b7a0417",
"company_code": "sample string 5",
"company": {
"id": "57df29cb-e4a6-4012-838d-a638ca268276",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-07T23:26:06.9387869+00:00",
"sales_territory_id": "3eba2ee6-775b-4318-a739-7652c71e2669",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bafc2085-91dc-4eb8-b48a-0d30fa2140ad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9d2b287a-e707-4a3f-acd4-30470efdf880",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3f1eabc3-893b-4690-b1b4-53cebbf1c188",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f062f71-681c-4bc6-b8c9-f534af752135",
"db_currency_id": "111870ea-4069-4d7c-8d63-e23360622fb4",
"db_language_id": "c0223f82-8504-4e70-b1a5-925bda59b885",
"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": "2025-06-07T23:26:06.9387869+00:00"
},
"modified_dateutc": "2025-06-07T23:26:06.9387869+00:00"
},
"marketing_segment_id": "65f7eff9-f0e1-400a-b290-a0fd62950130",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "08d4960c-cdcf-4b8a-b3f5-e49ce46ad96d",
"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": "dd5cdb00-8344-4437-817b-29cd7acd59af",
"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": "cae9e3ca-0f70-43f1-b0aa-bc7021ad84a8",
"db_country_code": "sample string 28",
"feelist_id": "47732b53-60ae-466a-8fae-d782e53e547e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b98c235c-d429-4e06-ae9b-2bbd8fc7bca1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dbd54630-2c57-40a3-8e8f-e73ec856d8c9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-07T23:26:06.9387869+00:00",
"db_currency_id": "560e856b-96cf-4175-a6f3-d0ecd8c91ffe",
"db_currency_code": "sample string 10"
},
"company_type_id": "2bdd27be-0b33-4f40-ba28-5705a8fed2e1",
"company_type_name": "sample string 32",
"company_type": {
"id": "35c8e131-4c44-43d3-b45a-fc3841ae8474",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e077a874-d7e8-4555-9903-214b2cbdbd9d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6286421f-10a1-4ea3-b908-e4333870f90a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6016aa6b-0afe-4f89-adcb-ffe6c123ecab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f1e20997-3b3b-4f7f-b4dc-ea58c10657cd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "37f7407f-0ce4-4945-ba63-05324d750ec2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-07T23:26:06.9387869+00:00"
},
"company_sector_id": "fa05d295-d0eb-4c19-b7c5-fa01941d292c",
"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": "cc0115bc-6055-49a9-b679-4c9a91c6042c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "73dc8f87-0fa6-4522-b10d-b7d9ecd6a6b1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "da023863-eee5-4a92-8217-8fe6bdfdb936",
"account_manager_user_code": "sample string 56",
"company_status_id": "a8faad33-13c6-4dd7-b72c-69f776333973",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-07T23:26:06.9387869+00:00",
"id2": 60
},
"db_language_id": "2d10f754-7950-46a1-803d-b4872a5bb3c6",
"db_language_code": "sample string 7",
"db_title_id": "d346c25c-b33c-4d11-a544-5994d2deff5a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-07T23:26:06.9387869+00:00",
"create_date": "2025-06-07T23:26:06.9387869+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": "2025-06-07T23:26:06.9387869+00:00"
}