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": "92ad9d47-9e2a-40c0-b510-0634aec67538",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ef6d3f5b-4b05-4a6e-8b72-aa671604b856",
"company_code": "sample string 5",
"company": {
"id": "870f2a8e-798c-4ef7-95e3-7f17eddb7a28",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-29T14:38:48.4762816+00:00",
"sales_territory_id": "e29c72e1-efaa-4d2c-95a4-c0916e293afd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "53ecab5d-702f-4dbb-b1ca-9a3281ff4a55",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b9433542-dccb-4788-8cfd-b83681b6f31c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ba58aa39-8104-436e-8055-936fe007a800",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b0a63ef-57e2-4871-988e-6056087db3f4",
"db_currency_id": "86203507-ac03-4462-b803-014612961dd0",
"db_language_id": "5344c4cd-1a29-49bd-bb62-3342a543910d",
"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-29T14:38:48.4762816+00:00"
},
"modified_dateutc": "2026-09-29T14:38:48.4762816+00:00"
},
"marketing_segment_id": "98fb3698-b482-425e-8118-ea6eda03ed00",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "074fe817-71c4-4ccc-9d54-1b9a1412dc83",
"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": "7364d349-34f0-470b-9005-c014d058e380",
"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": "db6ab28a-50ed-48cf-a84b-c24000cf0bdd",
"db_country_code": "sample string 28",
"feelist_id": "698d92cd-400f-44bf-aff6-cd0eb3fdeddc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2a7ecebb-b642-47c5-a1c2-d6dcdba8ad28",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "363b70c5-37cc-4040-a1c2-272d9c56557c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-29T14:38:48.4762816+00:00",
"db_currency_id": "5716414b-8ab8-474c-b1f8-1c993bf3aef8",
"db_currency_code": "sample string 10"
},
"company_type_id": "6a322ed2-8fd2-4b34-8a16-48d3f023cebf",
"company_type_name": "sample string 32",
"company_type": {
"id": "78d07a04-1e02-4b7b-8806-db0765060f2a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7f6a7485-a048-4d97-99ae-7e62645fa875",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1c594eab-da3c-4821-a212-7fd46b4ef1c2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c962763f-6976-4ed4-93b6-ea10255017a5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e030522a-0e4a-4023-8201-5a0b3c8c8242",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4247e6a0-7e90-4ceb-99d1-7d560dc53743",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-29T14:38:48.4762816+00:00"
},
"company_sector_id": "e62f80be-8df9-42bc-913d-0507b1b24671",
"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": "6d8caea9-f30c-4e76-ab79-fdb5363e6abe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bfd2c8cd-d988-481d-b5e4-9e1bf206ad78",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0395ca66-e78b-42f4-8a94-7ae86cb32c46",
"account_manager_user_code": "sample string 56",
"company_status_id": "7d279adb-c5bd-4197-b500-a8df5b7d9cbd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-29T14:38:48.4762816+00:00",
"id2": 60
},
"db_language_id": "dc013a34-7a5e-4084-ad82-3d48d9464965",
"db_language_code": "sample string 7",
"db_title_id": "22fb2268-4e63-4e06-a603-d04bc5f8b8b0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-29T14:38:48.4762816+00:00",
"create_date": "2026-09-29T14:38:48.4762816+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-29T14:38:48.4762816+00:00"
}