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": "b0856ad2-9ab5-4c51-b77c-8372a023673d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1a186d83-a9ff-4082-9de1-50753e80d443",
"company_code": "sample string 5",
"company": {
"id": "56c29d06-3e77-4552-8a12-6061c580b8a8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-08T11:03:25.9482295+00:00",
"sales_territory_id": "504e9cb2-39b8-46a7-91f9-89de641d204f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0c2d8613-cce2-4091-a04b-b3ebdd9b6915",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a27f1eb-b96f-4212-9869-fabf5f09936b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "292037bf-4315-4a76-a70b-f9b14b5d8975",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f69065b9-75dc-41c2-8418-d6997cffd535",
"db_currency_id": "ee3bea5f-56c8-4725-8666-6f640e641d8c",
"db_language_id": "5f85610b-c72e-4799-9010-e3d5b6a665d8",
"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-12-08T11:03:25.9482295+00:00"
},
"modified_dateutc": "2025-12-08T11:03:25.9482295+00:00"
},
"marketing_segment_id": "129ceb88-dd80-40c2-8772-4b0736ce55da",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e6467071-095b-4423-9285-f94f70de456d",
"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": "604d03d9-01c7-44dc-959c-ef7371e38d4a",
"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": "3bdad0a7-d893-4514-992f-7466c4d20952",
"db_country_code": "sample string 28",
"feelist_id": "423fef1f-2623-4aef-90e6-8339094eb349",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fdae4c8b-ab68-4cf2-8f16-da36098f8af4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fc3ab140-568f-4408-bd06-2e8e973a66ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-08T11:03:25.9482295+00:00",
"db_currency_id": "6a04c99c-702b-455a-a23b-51828552362d",
"db_currency_code": "sample string 10"
},
"company_type_id": "c00fc60f-e4bf-4b4e-b0eb-07437f323346",
"company_type_name": "sample string 32",
"company_type": {
"id": "91653d42-1a3b-4673-98dd-703ddd97d353",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "63b57274-f74e-43c2-874a-3274e6ddc1cb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "87958d84-e139-41d1-859e-88cdf6178134",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3540d887-c328-4d48-b522-ac64246fabe3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "46224454-4682-4e8a-9987-d68c6ff766af",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "736d06df-6129-46b8-8466-10259601287c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-08T11:03:25.9482295+00:00"
},
"company_sector_id": "a3cb04ee-af37-47dc-b32a-4e5d1268e7f9",
"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": "46ef8fc0-4360-4ae2-b228-4f34c3b4996a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ca3b3321-10c7-440a-aeb3-384f5ae4cce8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f8ad53a4-6eb8-4773-b452-2235d86a79a2",
"account_manager_user_code": "sample string 56",
"company_status_id": "3be956f8-275e-4659-86a5-59514ea5b552",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-08T11:03:25.9482295+00:00",
"id2": 60
},
"db_language_id": "5c04a477-33d7-4ff4-aa9a-2ce701385850",
"db_language_code": "sample string 7",
"db_title_id": "3f1279c9-25e7-479d-bda1-c0b28243d14e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-08T11:03:25.9482295+00:00",
"create_date": "2025-12-08T11:03:25.9482295+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-12-08T11:03:25.9482295+00:00"
}