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": "72f9fd50-fed5-4827-b2f5-e5447a47049b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a020ff90-5942-497e-bd40-5b935a5d2aff",
"company_code": "sample string 5",
"company": {
"id": "ef5f90bd-4983-4410-bc36-e0439718f8f0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-08T06:20:27.3137258+00:00",
"sales_territory_id": "9b1aa879-07b6-4e03-88c2-c7e5277a7e23",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "652e17af-def4-454b-88e3-ed6b308c7209",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9de1ba3b-0fbd-4d88-82b9-d846fe730c2f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c279f5a-4f33-4ad0-bb04-be968108cb99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "361edecc-44de-4391-8ed6-e4c176af16cf",
"db_currency_id": "4f35efc9-bfe1-4b35-83bc-5ebb68170d5c",
"db_language_id": "61224c1c-7416-456c-9005-24e55f1d615b",
"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-09-08T06:20:27.3137258+00:00"
},
"modified_dateutc": "2026-09-08T06:20:27.3137258+00:00"
},
"marketing_segment_id": "bb6f5b7c-3da1-4b2a-9049-48385623c685",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5c73a7d6-369d-4ae0-aa18-c5347f03d3fb",
"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": "56fa6350-e23e-4516-ad59-a59eca89bde2",
"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": "c2439520-e798-4085-ae5e-85ecda5e158a",
"db_country_code": "sample string 28",
"feelist_id": "ec819551-1710-4326-b4a2-b71c43ec1d78",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a6ecb0aa-2299-4cb9-91df-605a1e65b94d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b7c7942d-baab-4c03-b101-844c9c188d85",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-08T06:20:27.3137258+00:00",
"db_currency_id": "2a05f4da-3ddb-417b-90f5-c9431d714ed0",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2c08a6e-45e2-4bf3-b847-bc2c224d2be1",
"company_type_name": "sample string 32",
"company_type": {
"id": "775ef784-8769-4f28-9421-98d777bdb847",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9af36775-0386-4e92-8092-3a2ba14e1f88",
"sales_organization_code": "sample string 5"
},
"db_language_id": "18ccd360-85e3-4b91-9b11-08e181109e24",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fd76f4f2-047c-462c-a926-00526284209b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5e7984c8-ead0-4337-ad62-66538a43e794",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d7305412-f2e6-4b10-b045-097147742be7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-08T06:20:27.3137258+00:00"
},
"company_sector_id": "4f2d1fb9-cbee-4a2f-a31c-3c4a71357508",
"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": "006feccb-364b-44bb-a458-2c976e094fbb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "72d0631f-3a73-441c-8bd9-03048ce3a457",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "adb5604e-1fa0-48e6-bdce-ecc1f87117ea",
"account_manager_user_code": "sample string 56",
"company_status_id": "7a7186db-0b10-4743-ba52-a02aa2fc4c55",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-08T06:20:27.3137258+00:00",
"id2": 60
},
"db_language_id": "829750e1-fe46-4928-9164-f903cc31e539",
"db_language_code": "sample string 7",
"db_title_id": "b3fa9eae-2aa6-4eeb-b411-7def704f5461",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-08T06:20:27.3137258+00:00",
"create_date": "2026-09-08T06:20:27.3137258+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-09-08T06:20:27.3293497+00:00"
}