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": "3a94a22c-ca99-409e-b7b7-fc80e0edf0b6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1920fd1a-c1eb-468b-bac0-bd873670015e",
"company_code": "sample string 5",
"company": {
"id": "9a86c196-9fe4-4d9f-93d2-5876630ad613",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-12T01:55:17.3232052+00:00",
"sales_territory_id": "ec2f8e71-73e8-41b5-8d87-50fe16bf8131",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "58896c7d-9a57-42b1-aaaa-7dbcf0958ec3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1e178804-6e02-4b02-9de4-35f82d4a510f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6bbc1b83-39f4-4d62-a9f9-d569a81cce06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252befc6-540c-4ae7-9102-fc098b38bc01",
"db_currency_id": "e1fed5fd-7434-4cee-b843-dea90f63b933",
"db_language_id": "f0834bdb-18c0-4f0b-9146-97445d6739c5",
"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-12T01:55:17.3232052+00:00"
},
"modified_dateutc": "2026-09-12T01:55:17.3232052+00:00"
},
"marketing_segment_id": "00af0074-b5ef-49a9-9f79-ff2fdd9a71f0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "629bb8da-6787-4efd-a9ee-e512094ad486",
"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": "9f7333f6-31bd-4a54-81be-d4df16802602",
"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": "7bcd72e4-9297-4c14-9f53-2b24a27b387c",
"db_country_code": "sample string 28",
"feelist_id": "519ea9f8-4843-4499-9236-509be4a2414b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7b78b927-e4a9-4bd4-bc35-327edb3dcd0f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ec4fa249-f296-42e2-9b15-c9bde6f2d6ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-12T01:55:17.3232052+00:00",
"db_currency_id": "f3805484-2cb0-4d64-80c0-9187cf560378",
"db_currency_code": "sample string 10"
},
"company_type_id": "5c6bbeef-13ab-4c11-9a01-41a274d6f291",
"company_type_name": "sample string 32",
"company_type": {
"id": "2f20e2c8-6a02-40dc-9947-aec39eebf405",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ba1083f-3155-4651-aa59-a6ef662afd7f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8f5d135d-0f10-4141-812b-826c15bc3468",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "35324b90-8eee-4c16-afc9-58f09d966e9d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "789bd225-f6d8-4fe4-90d0-e89a8ed0e814",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1784b126-e9ac-4fc1-8845-7612c65df353",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-12T01:55:17.3232052+00:00"
},
"company_sector_id": "57da205e-4c35-4e06-9a20-e8abb19efa3b",
"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": "2809c909-5f04-4d64-9fca-fcfdabdace40",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ff8994a5-175e-4db5-85c6-858a474a7b1b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c58fbb1e-d9ca-4759-91e3-73a6a9886ab0",
"account_manager_user_code": "sample string 56",
"company_status_id": "9458f9b2-9f0f-4c09-afc1-310fd8fa8ad8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-12T01:55:17.3232052+00:00",
"id2": 60
},
"db_language_id": "81b87794-71cc-425e-949e-27e8b20a0b3a",
"db_language_code": "sample string 7",
"db_title_id": "ec71f00d-5232-41c3-a11f-73252784332b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-12T01:55:17.3232052+00:00",
"create_date": "2026-09-12T01:55:17.3232052+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-12T01:55:17.3232052+00:00"
}