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": "3767ef35-61e3-4d0a-a51e-0878a637703c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ffc57e55-d0dd-4acb-860c-5b61736dfb6d",
"company_code": "sample string 5",
"company": {
"id": "49346c6e-4c04-4ae4-beff-7d1e3b9f9d16",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-21T01:14:13.7627087+00:00",
"sales_territory_id": "8a12b2cd-d714-4e69-b28d-87fe7c5fb92f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b43bce54-624e-4fae-8b46-bee41c30e98a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd365ad6-3950-4cec-99db-0c9b2470bf8d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "577355ef-d5b6-4520-9f7d-ee4a27132068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "998330b3-350c-423e-97f0-b82fcba6f5df",
"db_currency_id": "36423a25-2c52-44b9-bcc5-b4d78cae801d",
"db_language_id": "3928ff8f-dfd0-4c19-993f-7f093b60ab85",
"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-05-21T01:14:13.7627087+00:00"
},
"modified_dateutc": "2026-05-21T01:14:13.7627087+00:00"
},
"marketing_segment_id": "c1ac7bcd-75e2-41d8-96cb-fc0f1fc97604",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3ee7fa40-a916-448e-b9d7-0faafe5165bf",
"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": "868881d6-c897-408f-a914-476e7de22517",
"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": "b5282d78-1b51-408f-a0e9-0a681ef9b774",
"db_country_code": "sample string 28",
"feelist_id": "37776da4-27c9-4975-b784-da38a10db735",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a906a0b0-0e0a-406b-a221-f62106e871f2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bda84d7d-afe6-49e3-b35d-a1c565d6ba61",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-21T01:14:13.7627087+00:00",
"db_currency_id": "c000283d-fc02-4b9f-ae88-74d08aaeda4c",
"db_currency_code": "sample string 10"
},
"company_type_id": "af2be14a-60a8-4b40-972f-af986601aaa9",
"company_type_name": "sample string 32",
"company_type": {
"id": "755d3fdf-3a98-4c58-b8bf-604f7d5e0608",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b11cae8b-24fa-4e48-9972-7f17fa6f0ea0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "661e2f39-7e35-4ca5-be2a-795f4005e16f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e1169ec0-36f2-4ecb-a3a3-21814360e026",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d2195409-7a6c-4abe-84b0-7eadfce1f729",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "571e8622-d325-40be-977f-48889ecefad7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-21T01:14:13.778332+00:00"
},
"company_sector_id": "4a3dde8f-8f6e-484f-bc49-b216954f1a00",
"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": "7e09b0bd-1ce9-40c8-9b2b-36f55f382068",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1b50c486-7e51-48c7-86e3-a141f4a10cf2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e5614bfd-bf3f-4d00-9a32-24cbf3f7bb9f",
"account_manager_user_code": "sample string 56",
"company_status_id": "1c6b87a0-ec31-443c-9b47-75e905cb765b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-21T01:14:13.778332+00:00",
"id2": 60
},
"db_language_id": "623f7a3b-13a7-4c8b-9642-a7eccdab5419",
"db_language_code": "sample string 7",
"db_title_id": "107f35c9-dfe8-4dc7-8698-c1cefcdda2db",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-21T01:14:13.778332+00:00",
"create_date": "2026-05-21T01:14:13.778332+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-05-21T01:14:13.778332+00:00"
}