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": "0864d4e2-9ac2-4ca2-be02-2e25f6d642ca",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "15a95835-4613-40cf-aa45-d981ad6415a5",
"company_code": "sample string 5",
"company": {
"id": "c5366ff5-bd47-4fa0-9203-e937a93743a8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-22T23:15:42.866893+00:00",
"sales_territory_id": "3fa03c94-7675-4c9d-ae5e-26ef3ae07724",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "735c1a0d-e132-4f51-ab0d-7c2f6da50c5d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bbf12c98-dc28-4e91-b05c-658bf1b51860",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "953ed75f-b4be-4876-b76c-f41213137a9a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6365ee-165e-418a-9ef9-d30aed302e57",
"db_currency_id": "f42253cc-7a30-4853-8c72-0271179f5767",
"db_language_id": "1dbaa47d-851e-4c6f-8d7c-4fadbcaa43e0",
"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-22T23:15:42.866893+00:00"
},
"modified_dateutc": "2026-09-22T23:15:42.866893+00:00"
},
"marketing_segment_id": "e329fe79-3d83-4f38-92ca-18ea74e062d0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "277759b8-8729-426b-943b-ba4ecf535383",
"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": "66ce9497-b32f-4a4d-83e4-41961e092185",
"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": "47aed15d-a0ac-499d-acb9-b15e417de567",
"db_country_code": "sample string 28",
"feelist_id": "a692b251-e0d0-4266-9048-033577aba781",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2c344be4-08c1-46cb-9a36-647b4c1fe826",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8837a13c-83ca-4c59-9a25-cf852895e427",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-22T23:15:42.8825206+00:00",
"db_currency_id": "6d229303-67e0-41dd-9c6f-bf640527ac9e",
"db_currency_code": "sample string 10"
},
"company_type_id": "9a9963be-a945-43b3-96cd-f58075ab36ad",
"company_type_name": "sample string 32",
"company_type": {
"id": "629bddc9-bff0-4a5b-bec3-1039a98df500",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4fedc94e-d1e6-458c-aec3-3240245da8a7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9bcc9f2f-7ecb-4f34-86ad-d9c335ba7103",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "02f4090d-d391-4c17-b23a-f99c2d1f13ef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8d58359f-1427-4d82-a0a7-ec3f04132bc6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e164224a-74df-41af-a974-82a54635840c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-22T23:15:42.8825206+00:00"
},
"company_sector_id": "0890028c-c280-4345-a8a9-dcf2f0cfaee1",
"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": "c6b2064e-7b1a-4dac-af58-af2917a61f91",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5e374c36-ee61-4473-bb23-b01c64eacbd4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f8a83239-25ca-4b42-8ac3-91b9c9448dd8",
"account_manager_user_code": "sample string 56",
"company_status_id": "9cbe2ff9-bdcd-436c-a8e8-03d096b1efa4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-22T23:15:42.8825206+00:00",
"id2": 60
},
"db_language_id": "38105c9e-a6e1-43a3-b311-5485d0723228",
"db_language_code": "sample string 7",
"db_title_id": "fc714013-7f13-471e-9f50-ce5056b8a643",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-22T23:15:42.8825206+00:00",
"create_date": "2026-09-22T23:15:42.8825206+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-22T23:15:42.8825206+00:00"
}