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": "57bd70df-8bfd-42ab-a073-f4dab8a9b9ed",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b8ef6b6e-44dd-4997-9f88-6ab70b464ae4",
"company_code": "sample string 5",
"company": {
"id": "7696281d-e52b-4e5b-a2f0-f6e2a9a4e75d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-13T06:31:47.0783258+00:00",
"sales_territory_id": "7b8b2642-5eaf-4e84-823b-ac13418dabe9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4a5f83f9-34e5-4660-ab25-18f60230a422",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6f1284d6-3099-4122-9456-fa7b340d8b0a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0209a4ff-cbdb-400a-9792-13a13413faf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c11842a7-c0ad-4651-8aae-281d83209473",
"db_currency_id": "bc9445d1-36af-4e57-aad0-2f728f81fb30",
"db_language_id": "c7e6b5e6-0953-426a-b979-3c4e5e4f6529",
"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-13T06:31:47.0783258+00:00"
},
"modified_dateutc": "2026-07-13T06:31:47.0783258+00:00"
},
"marketing_segment_id": "4ecb5e60-e00d-4c1b-a343-4693ff79c95b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b2c3d620-b7a9-4711-ae83-615654f6f482",
"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": "8d410af9-ccd5-4662-9a76-2a144a5ab0ac",
"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": "cb6acd9d-68d3-418a-b406-854508b44d32",
"db_country_code": "sample string 28",
"feelist_id": "1a34e7fa-49a0-4f27-ae68-32e72d0424d7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fcf0b512-9733-4a4d-a7e0-a0ff6e2f68d3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "836ce657-9981-465e-85e8-016a1b2862e1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-13T06:31:47.0783258+00:00",
"db_currency_id": "9b65ad7a-5677-4060-b120-2e911be82678",
"db_currency_code": "sample string 10"
},
"company_type_id": "52492fb3-ba30-4218-9d21-6d327a90deed",
"company_type_name": "sample string 32",
"company_type": {
"id": "d5fa5d82-1169-443d-9e37-c56d5171d28c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ad61b006-9f95-4c33-800d-0b3fcecac14d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "233ca82b-0e30-448a-bb20-0c05e167a239",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "72147050-eb98-4863-b78f-07e957ad37f7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b6678103-c223-40ad-8eb7-8ca519c8f4a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2b250d80-88d9-4d41-924a-29d70fdb7cdb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-13T06:31:47.0783258+00:00"
},
"company_sector_id": "b89d5711-2210-4b71-87c1-6653cff7821a",
"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": "09a702f4-bc2c-4518-9e97-1c1dfc6cfc1b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7862b9d6-8bb8-4ffd-b4f8-b4f404910f29",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "83b945e6-2442-4e9f-a541-d84fe04fc2f1",
"account_manager_user_code": "sample string 56",
"company_status_id": "00fe9942-7cbc-4766-a4e2-c2338b63053e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-13T06:31:47.0783258+00:00",
"id2": 60
},
"db_language_id": "be51cc16-7696-422d-bcf1-c41e4316aea9",
"db_language_code": "sample string 7",
"db_title_id": "95dd0685-f0b4-4d99-becc-580a95299fe5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-13T06:31:47.0783258+00:00",
"create_date": "2026-07-13T06:31:47.0783258+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-13T06:31:47.0783258+00:00"
}