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": "1a8d4252-6434-416e-aac7-c5be5fac5bc4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d11a9a8e-b091-43b4-9afd-e88c559291ea",
"company_code": "sample string 5",
"company": {
"id": "912665c4-02c1-4b71-8f60-71e3072408e2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-10T04:21:57.3676675+00:00",
"sales_territory_id": "cf6229b1-7f0f-48ef-a8bd-4be6ec4fd88f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "de306e8b-7d57-467c-ac60-dc8aa1be4885",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d41e7219-b4ef-4f87-91a7-d13059258fe3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dc693058-03a8-4b29-a499-e29f00131b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1844707c-506a-40b2-9bf8-2d23b7c4362d",
"db_currency_id": "6c286c10-cdda-40eb-b7e6-f6d4a470946b",
"db_language_id": "6ee5c17d-da1f-4a4d-aa76-3443f3e85eb1",
"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-10T04:21:57.3676675+00:00"
},
"modified_dateutc": "2025-12-10T04:21:57.3676675+00:00"
},
"marketing_segment_id": "5ab0d8b4-1d4c-4196-abe1-d97ef4207e69",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "54e621c5-e1ff-48e8-80d6-5a8fc87140de",
"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": "e8f71cb8-7758-464e-8607-df5de4172c16",
"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": "d1d202e7-ab9a-4ec2-8725-ea55cf3974f4",
"db_country_code": "sample string 28",
"feelist_id": "572d51e3-fab7-4a8a-9e57-81f2a2f5a3be",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0a5b785e-d434-4775-9a01-06b1fa229e36",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ca86fb0c-6031-4ade-9090-9b3a84d9662e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-10T04:21:57.3676675+00:00",
"db_currency_id": "67a05ded-10db-4304-b096-d39cc72a4c23",
"db_currency_code": "sample string 10"
},
"company_type_id": "a032702c-cfe3-42a0-b8b4-b223753482b3",
"company_type_name": "sample string 32",
"company_type": {
"id": "c7c7816d-d0ee-4d67-8668-0a7ff15b0dac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "08ebf744-85df-4db9-ba87-10d1dbdcd5fb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "56c4faf8-2b1f-4d00-9030-7d57d83f3ec7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "87c19c07-81ab-4e59-8751-1a16c6510ec4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8f1b26f6-0612-4495-91ad-8e5ccb19ea2f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "33e64b91-bac9-403a-a3b4-a1d301951911",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-10T04:21:57.3676675+00:00"
},
"company_sector_id": "437f9f5d-2603-4ed2-8b22-cf950b05d1d6",
"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": "999ebf30-11fb-466f-aa94-c71ddbadc7b1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a6b5e469-9a73-4e3a-9752-1d2ead708ee2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "023bab28-2ca8-4aed-9a24-98160a0cf54b",
"account_manager_user_code": "sample string 56",
"company_status_id": "7648246e-e45b-4bb2-9ad6-7f77d1954fa9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-10T04:21:57.3676675+00:00",
"id2": 60
},
"db_language_id": "df0480cc-f938-4bf9-8beb-662e1d60ac45",
"db_language_code": "sample string 7",
"db_title_id": "866b5348-9c02-4875-a295-9e7fdbd3ec35",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-10T04:21:57.3676675+00:00",
"create_date": "2025-12-10T04:21:57.3676675+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-10T04:21:57.3676675+00:00"
}